Описание API v1.1.33 от 05.11.2026 11:31

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

Количество доступных на данный момент методов: 442

Авторизация
Авторизация
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
user_login string (50) Да - Логин доступа к БД
user_password password (50) Да - Пароль доступа к БД
db_type string (10) Да - Тип БД (postgresql/mssql)
db_server string (255) Да - Сервер БД. Порт можно указать в формате host:port или отдельным параметром db_port
db_port integer (10) - Порт БД. Обязателен, если не указан в db_server. Значения по умолчанию нет (обычно 5432 для PostgreSQL, 1433 для MSSQL)
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 Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
ip string (255) IP клиента
refresh_token string (255) Ключ обновления токена (также устанавливается в httpOnly-cookie)
data Данные (копия основных параметров ответа для удобства использования)
— token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
— valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
— ip string (255) IP клиента
— refresh_token string (255) Ключ обновления токена (также устанавливается в httpOnly-cookie)

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

{
    "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",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "data": {
        "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
        "valid_to": "2001-01-01 01:01:01",
        "ip": "145.123.53.25",
        "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
    }
}
Описание
Для входа необходимо указать порт БД в db_port либо в db_server в формате host:port. Перед подключением проверяется сложность пароля; при недостаточной сложности возвращается ошибка 1001.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
1000 Некорректный порт БД.
1001 Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%^&*()\\_
1002 IP адреса "%s" нет в белом списке
1003 База данных не распознана.
1004 Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота.
1005 Лицензия не найдена.
1006 Серийный номер некорректен.
1007 Превышено кол-во активных пользователей в лицензии.
1008 Пользователь не активирован.
1009 Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору.
1010 Ошибка проверки безопасности пользователя для работы через API.
Завершение авторизации
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.logout",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Удаляет переданный токен доступа и связанный с ним refresh_token, очищает cookie refresh_token.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Авторизация для организаций
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
user_login string (50) Да - Логин доступа к БД
user_password password (50) Да - Пароль доступа к БД
org_ident string (50) Да - Идентификатор организации. Можно получить у разработчика.

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

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

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

{
    "request_identifier": "alphapi.auth.org",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "db_type": "mssql",
    "storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/",
    "data": {
        "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
        "valid_to": "2001-01-01 01:01:01",
        "ip": "145.123.53.25",
        "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
        "db_type": "mssql",
        "storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/"
    }
}
Описание
Подключение к БД выполняется по настройкам организации org_ident. Перед подключением проверяется сложность пароля; при недостаточной сложности возвращается ошибка 1001.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
126 Неизвестный идентификатор организации "%s"
127 Внутренняя ошибка настроек организации.
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
134 Для указанной организации используется внешний API. Актуальный URL: %s
1000 Некорректный порт БД.
1001 Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%^&*()\\_
1002 IP адреса "%s" нет в белом списке
1003 База данных не распознана.
1004 Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота.
1005 Лицензия не найдена.
1006 Серийный номер некорректен.
1007 Превышено кол-во активных пользователей в лицензии.
1008 Пользователь не активирован.
1009 Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору.
1010 Ошибка проверки безопасности пользователя для работы через API.
Обновить токен
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
refresh_token string Да - Ключ обновления токена, полученный при авторизации. Для обратной совместимости можно передавать в теле запроса, иначе берется из httpOnly-cookie.

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

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

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

{
    "request_identifier": "alphapi.auth.refresh",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "data": {
        "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
        "valid_to": "2001-01-01 01:01:01",
        "ip": "145.123.53.25",
        "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
    }
}
Описание
Обновляет токен по refresh_token из тела запроса или httpOnly-cookie. Параметры подключения к БД берутся из сохраненной сессии. Ошибка обновления токена имеет код 1001.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
1000 Некорректный порт БД.
1001 Ошибка обновления токена; Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%^&*()\\_
1002 IP адреса "%s" нет в белом списке
1003 База данных не распознана.
1004 Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота.
1005 Лицензия не найдена.
1006 Серийный номер некорректен.
1007 Превышено кол-во активных пользователей в лицензии.
1008 Пользователь не активирован.
1009 Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору.
1010 Ошибка проверки безопасности пользователя для работы через API.
Справочники
Активные пользователи
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.active.users.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "EXT_GROUPS": "#1#",
                "Активный": 1,
                "Логин": "alpha-101",
                "Основная группа": "Основная группа",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Примечание": "Текст примечания",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Сервер": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Штрих-коды
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.codes.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ISSUE_ID": 101,
                "CODE_ID": 100001,
                "Штрих": "55-100001",
                "Дата": "2026-01-01 00:00:00"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить назначенный штрих-код
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
code_id integer (10) Да - ID штрих-кода

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

{
    "token": "unique_token_for_30_minutes",
    "code_id": 100001
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.codes.assignedbarcode.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— barcode string (255) Назначенный штрих-код объекта

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

{
    "request_identifier": "alphapi.codes.assignedbarcode.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": {
            "barcode": "5500000001"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Выпустить коды
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
codes_count integer (10) Да - Количество кодов для выпуска

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

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

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

{
    "request_identifier": "alphapi.codes.issue",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Codes issued successfully.",
    "data": {
        "issue_id": 123456
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит должностей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1883,
                "POS_ID": 107,
                "Дата время": "2022-06-03 12:29:05",
                "Параметр01": "value1",
                "Параметр02": "value2",
                "Станция": "irisDB01",
                "Номер": 107,
                "Логин": "Andrey",
                "ФИО": "Андрей Иванович Петров",
                "Пользователь": "user01",
                "Приоритет события": 5,
                "Событие": "Изменение должности"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Дерево должностей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.parents.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 128,
                "POS_ID": 105,
                "PARENTS": "#105#",
                "Сервер": 1,
                "Расширенное название": "Юрист [Иванов Иван]",
                "Название": "Юрист",
                "Активна": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Реестр должностей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 48,
                "POS_ID": 102,
                "PARENTS": "#102#",
                "Номер": 102,
                "Логин": "ivanovii",
                "Сервер": 1,
                "Должность": "Ведущий специалист",
                "ФИО": "Иванов Иван Иванович",
                "Подразделение": "Дирекция",
                "Примечание": "Тестовая должность",
                "Активна": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Должности без справочников
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "POS_ID": 101,
                "PARENTS": "#101#",
                "LOGIN_ID": 101,
                "Название": "Директор",
                "Подразделение": "Дирекция",
                "Примечание": null,
                "Активна": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Сотрудник, назначенный на должность
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
pos_id integer (10) Да - ID должности
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.users.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LOGIN_ID": 102,
                "Логин": "ivanovii"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступ к должностям (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Номер = 'A'",
    "orderby": "Номер ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.positions.access.directory.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — POS_ID integer (10) ID должности
— — Номер integer (10) Внутренний номер должности (равен ID должности)
— — Логин string (50) Логин пользователя, назначенного на должность
— — Должность string (255) Название должности
— — ФИО string (255) ФИО пользователя, назначенного на должность
— — Активна boolean (1) Флаг активности должности
— — CustomKey string (1023) Уникальный ключ
— — Тип string (255) Тип
— — Источник string (50) Источник
— — Объект string (255) Объект
— — Пользователь string (255) Пользователь
— — Родитель string (255) Родитель
— — Примечание string (255) Примечание должности

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

{
    "request_identifier": "alphapi.positions.access.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "POS_ID": 101,
                "Номер": 101,
                "Логин": "Andrey",
                "Должность": "специалист",
                "ФИО": "Андрей Иванович Петров",
                "Активна": 1,
                "CustomKey": "Назначенный.101.1.102",
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Андрей П",
                "Пользователь": "Андрей П",
                "Родитель": "Бухгалтер",
                "Примечание": "примечание"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступ к должностям
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Назначенный.101.1.102",
                "PROVIDER_TABLE_ID": 3,
                "PROVIDER_ID": 5,
                "RECIPIENT_TABLE_ID": 7,
                "RECIPIENT_ID": 99,
                "TABLE_ID": 1,
                "POS_ID": 109,
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Андрей П",
                "Родитель": "Андрей П",
                "Примечание": "Бухгалтер",
                "ACCESS_ID": 124
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Комментарии должностей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 48,
                "COMMENT_ID": 101,
                "POS_ID": 102,
                "Номер": 102,
                "ФИО": "Иванов Иван Иванович",
                "Логин": "ivanovii",
                "Должность": "Ведущий специалист",
                "Дата время": "2024-01-01 10:00:00",
                "Комментарий": "Комментарий к должности",
                "Пользователь": "Петров Петр Петрович"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Должности. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "POS_ID": 101,
                "Раздел": "Должности",
                "Объект": "Бухгалтер",
                "Дата": "2001-01-01 01:01:01",
                "Индекс": "индекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Должности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.positions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "POS_ID": 101,
                "Номер": 101,
                "PARENTS": "#101#",
                "След": null,
                "Логин": "alpha-101",
                "Сервер": 1,
                "Должность": "Ведущий специалист",
                "ФИО": "Петров Василий Иванович",
                "Email": "email@example.com",
                "Подразделение": "Дирекция",
                "Телефон": "+74951234567",
                "Примечание": null,
                "Активна": 1,
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контакты (Расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.users.contacts.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "CONTACT_ID": 101,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "LOGIN_ID": 34,
                "Логин": "user01",
                "Пользователь": "Первый пользователь",
                "ФИО": "Петров Александр Иванович",
                "Должность": "Директор",
                "ДР": "",
                "Тип": "Поставщик",
                "Контакт": "тел. 83504332, почта top@sales.com",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Адреса пользователей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.users.address.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ADDRESS_ID": 101,
                "LOGIN_ID": 34,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "Активный": 1,
                "Логин": "alpha-101",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Тип": "Поставщик",
                "Адрес": "тел. 83504332, почта top@sales.com",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Пользователи
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.users.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "EXT_GROUPS": "#1#",
                "Активный": 1,
                "Логин": "alpha-101",
                "Основная группа": "Основная группа",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Примечание": "Текст примечания",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Сервер": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Статусы точек маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.statuses.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "RPS_ID": 1,
                "Название": "Новый",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Исполнители для стандартных маршрутов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.responsibles.forsr.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1071",
                "Тип": "Пользователи",
                "RESPONSIBLE_TABLE_ID": 101,
                "RESPONSIBLE_ID": 10,
                "Сервер": 1,
                "Исполнитель": "Сидоров С.С.",
                "Должность": "Директор",
                "ФИО": "Сидоров С.С.",
                "LOGIN_ID": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Дерево исполнителей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.responsibles.parents.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 48,
                "ID": 101,
                "PARENTS": "#101#",
                "Сервер": 1,
                "Название": "Пользователи",
                "Активна": 1,
                "Папка": 0
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Исполнители (Расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.responsibles.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1071",
                "Тип": "Пользователи",
                "RESPONSIBLE_TABLE_ID": 101,
                "RESPONSIBLE_ID": 10,
                "Сервер": 1,
                "Исполнитель": "Сидоров С.С.",
                "Должность": "Директор",
                "ФИО": "Сидоров С.С.",
                "LOGIN_ID": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы точек маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.types.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "RPT_ID": 1,
                "Название": "Поручение",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать банк
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
bank_id integer (10) Да - ID банка
bank_name string (255) Да - Название банка
bik string (9) Да - Банковский идентификационный код
kc string (20) Да - Корреспондентский счет
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.banks.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank edited successfully",
    "data": {
        "bank_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить банк
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
bank_name string (255) Да - Название банка
bik string (9) Да - Банковский идентификационный код
kc string (20) Да - Корреспондентский счет
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.banks.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank added successfully",
    "data": {
        "bank_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Банки
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.banks.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (5) ID таблицы
— — ROW_ID integer (10) ID записи
— — BANK_ID integer (10) ID банка
— — Название string (255) Название банка
— — БИК string (9) Банковский идентификационный код
— — КС string (20) Корреспондентский счет
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.banks.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 31,
                "ROW_ID": 11,
                "BANK_ID": 34,
                "Название": "Сбербанк",
                "БИК": "123456789",
                "КС": "12345678901234567890",
                "Примечание": "примечание"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить банк
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
bank_id integer (10) Да - ID банка

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

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

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

{
    "request_identifier": "alphapi.banks.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит проектов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "AUDIT_ID = 'A'",
    "orderby": "AUDIT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.projects.audit.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — AUDIT_ID integer (17) ID записи аудита
— — Дата время datetime (Y-m-d H:i:s) Дата и время события
— — Параметр01 string (305) Параметр 01
— — Параметр02 string (305) Параметр 02
— — Станция string (255) Станция
— — Пользователь string (564) Пользователь
— — Приоритет события integer (10) Приоритет события
— — Событие string (255) Событие
— — P_ID integer (10) ID проекта
— — Номер integer (10) Номер проекта
— — Название string (255) Название проекта
— — Активен boolean (1) Активен ли проект
— — Ответственный string (255) Ответственный
— — План-график date (Y-m-d H:i:s) План-график

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

{
    "request_identifier": "alphapi.projects.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 5001,
                "Дата время": "2026-01-20 10:11:12",
                "Параметр01": "old",
                "Параметр02": "new",
                "Станция": "irisDB01",
                "Пользователь": "developer",
                "Приоритет события": 5,
                "Событие": "Изменение проекта",
                "P_ID": 101,
                "Номер": 101,
                "Название": "Проект 101",
                "Активен": 1,
                "Ответственный": "Иванов И.И.",
                "План-график": "2026-12-31 00:00:00"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Дерево проектов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.parents_get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 49,
                "P_ID": 103,
                "PARENTS": "#103#",
                "Название": "Договора и ДС",
                "Активен": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Реестр проектов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "P_ID": 1012,
                "Номер": 1012,
                "Активен": 1,
                "Название": "Проект закупок",
                "Ответственный": "Иванов Иван Иванович",
                "Примечание": "Тестовый проект"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проекты без справочников
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "P_ID": 101,
                "PARENTS": "#101#",
                "Название": "Название проекта",
                "Создан": "2001-01-01 01:01:01",
                "Активен": 1,
                "RESPONSIBLE_ID": 102,
                "План-график": "2001-01-01 01:01:01",
                "Код": "",
                "Цвет": null,
                "БлокЦвета": null,
                "Примечания": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Ответственный проекта
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
p_id integer (10) Да - ID проекта
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.users.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LOGIN_ID": 102,
                "ФИО": "Иванов Иван Иванович"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступы к проектам (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.access.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Назначенный.101.2.1",
                "P_ID": 101,
                "Номер": 101,
                "Активен": 1,
                "Название": "проект1107730",
                "Ответственный": "Разработчик",
                "Тип": "Назначенный",
                "Источник": "Группы пользователей",
                "Объект": "Администраторы",
                "Пользователь": "Разработчик",
                "Родитель": "проект1107730",
                "Примечание": "Встроенная группа"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступы к проектам
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Назначенный.100.1.105",
                "PROVIDER_TABLE_ID": 49,
                "PROVIDER_ID": 100,
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 105,
                "TABLE_ID": 49,
                "P_ID": 100,
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Разработчик",
                "Родитель": "проект1107730",
                "Примечание": "Представитель разработчика",
                "ACCESS_ID": 1075
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Комментарии проектов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 49,
                "COMMENT_ID": 101,
                "P_ID": 1012,
                "Номер": 1012,
                "Название": "Проект закупок",
                "План-график": "2024-01-01 00:00:00",
                "Ответственный": "Иванов Иван Иванович",
                "Дата время": "2024-01-01 10:00:00",
                "Комментарий": "Комментарий к проекту",
                "Пользователь": "Петров Петр Петрович"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проекты. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "P_ID": 101,
                "Раздел": "Проекты",
                "Объект": "Заведение и распределение счетов",
                "Индекс": "Заведение и распределение счетовИванов Иван",
                "Дата": "2019-09-19 18:03:06"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проекты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.projects.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "P_ID": 101,
                "PARENTS": "#101#",
                "RESPONSIBLE_ID": 101,
                "Номер": 101,
                "След": null,
                "Название": "Название проекта",
                "Код": "",
                "Создан": "2001-01-01 01:01:01",
                "Активен": 1,
                "План-график": "2001-01-01 01:01:01",
                "Цвет": null,
                "БлокЦвета": null,
                "Примечание": "Текст примечания",
                "Ответственный": "Иванов И.И."
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать проект
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
p_id integer (10) Да - ID проекта
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID проекта)
name string (255) Да - Название
enable boolean (1) - Флаг активности
login_id integer (10) Да - LOGIN_ID ответственного по проекту
planschedule date (YYYY-MM-DD) Да - Дата план графика проекта
key string (20) - Поле связи проекта со внешними системами
color integer (10) - Цветовой тег проекта, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736
comment string (255) - Комментарий

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

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

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

{
    "request_identifier": "alphapi.project.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project edited successfully",
    "data": {
        "p_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить доступ к проекту
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
p_id integer (10) Да - ID проекта
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.project.access.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project access added successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить доступ к проекту
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
p_id integer (10) Да - ID проекта
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.project.access.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project access deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить проект
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID проекта)
name string (255) Да - Название
enable boolean (1) - Флаг активности
login_id integer (10) Да - LOGIN_ID ответственного по проекту
planschedule date (YYYY-MM-DD) Да - Дата план графика проекта
key string (20) - Поле связи проекта со внешними системами
color integer (10) - Цветовой тег проекта, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736
comment string (255) - Комментарий

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

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

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

{
    "request_identifier": "alphapi.project.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project added successfully",
    "data": {
        "p_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать контакт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
contact_id integer (10) Да - ID контакта
contact_type string (50) Да - Тип контакта
contact string (255) Да - Контакт
comment string (255) - Примечание контакта
mask string (305) - Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

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

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

{
    "request_identifier": "alphapi.contact.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact edited successfully",
    "data": {
        "contact_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать контакт (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
contact_id integer (10) Да - ID контакта
fio string (255) - ФИО
position string (50) - Должность
birth_day date (YYYY-MM-DD) - Дата рождения
contact_type string (50) Да - Тип контакта
contact string (255) Да - Контакт
comment string (255) - Примечание контакта
mask string (305) - Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

{
    "token": "unique_token_for_30_minutes",
    "contact_id": 2323233,
    "fio": "Иванов Иван Иванович",
    "position": "Управляющий",
    "birth_day": "13.01.1998",
    "contact_type": "поставщик",
    "contact": "тел. +738459663",
    "comment": "примечание",
    "mask": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.contact.ext.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— contact_id integer (10) ID контакта

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

{
    "request_identifier": "alphapi.contact.ext.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Extended contact edited successfully",
    "data": {
        "contact_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить контакт (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (5) Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer (10) Да - ID сущности
fio string (255) - ФИО
position string (50) - Должность
birth_day date (YYYY-MM-DD) - Дата рождения
contact_type string (50) Да - Тип контакта
contact string (255) Да - Контакт
comment string (255) - Примечание контакта
mask string (305) - Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 3,
    "fio": "Иванов Иван Иванович",
    "position": "Управляющий",
    "birth_day": "13.01.1998",
    "contact_type": "поставщик",
    "contact": "тел. +738459663",
    "comment": "примечание",
    "mask": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.contact.ext.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— contact_id integer (10) ID контакта

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

{
    "request_identifier": "alphapi.contact.ext.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Extended contact added successfully",
    "data": {
        "contact_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить контакт (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
contact_id integer (10) Да - ID контакта

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

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

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

{
    "request_identifier": "alphapi.contact.ext.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Extended contact deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Используемые маски контактов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.contact.masks.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "телефон",
                "Маска": "Телефон\\:<>999\\-999\\-99\\-99<>"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы контактов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.contact.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "поставщик11701007"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить контакт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (5) Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer (10) Да - ID сущности
contact_type string (50) Да - Тип контакта
contact string (255) Да - Контакт
comment string (255) - Примечание контакта
mask string (305) - Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

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

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

{
    "request_identifier": "alphapi.contact.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact added successfully",
    "data": {
        "contact_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Используемые значения контактов с маской ввода
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.contact.values.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "PARENT_TABLE_ID": 6,
                "Тип": "поставщик11701000",
                "Контакт": "тел. +78002353535"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить контакт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
contact_id integer (10) Да - ID контакта

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

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

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

{
    "request_identifier": "alphapi.contact.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать должность
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
pos_id integer (10) Да - ID редактируемой должности
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID точки должности)
name string (255) Да - Название должности
login_id integer (10) Да - ID пользователя, который занимает должность
sub_unit string (255) - Подразделение должности
comment string (255) - Комментарий должности
active boolean (1) - Флаг активности должности

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

{
    "token": "unique_token_for_30_minutes",
    "pos_id": 123,
    "parents": "#101##102#",
    "name": "Главный бухгалтер",
    "login_id": 101,
    "sub_unit": "Бухгалтерия",
    "comment": "комментарий",
    "active": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.position.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.position.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Position edited successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить доступ к должности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
pos_id integer (10) Да - ID должности
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.position.access.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Position access added successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить доступ к должности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
pos_id integer (10) Да - ID должности
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.position.access.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Position access deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить должность
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID точки должности)
name string (255) Да - Название должности
login_id integer (10) Да - ID пользователя, который занимает должность
sub_unit string (255) - Подразделение должности
comment string (255) - Комментарий должности
active boolean (1) - Флаг активности должности

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

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

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

{
    "request_identifier": "alphapi.position.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Position added successfully",
    "data": {
        "pos_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активные типы ссылок
URL:
Эмулятор
Типы ссылок
URL:
Эмулятор
Редактировать тип ссылки
URL:
Эмулятор
Установить активность типа ссылки
URL:
Эмулятор
Добавить тип ссылки
URL:
Эмулятор
Удалить тип ссылки
URL:
Эмулятор
Правовые формы
URL:
Эмулятор
Редактировать запись в календаре
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
day_id integer (10) Да - ID записи в календаре
date date (YYYY-MM-DD) - Дата
dt_id integer Да - ID типа
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.calendar.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Day edited successfully",
    "data": {
        "day_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить запись в календарь
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
date date (YYYY-MM-DD) - Дата
dt_id integer Да - ID типа
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.calendar.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Day added successfully",
    "data": {
        "day_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Рабочий календарь без справочников
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.calendar.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DAY_ID": 6,
                "Номер": 6,
                "Тип": "Выходной",
                "Дата": "2001-01-01 00:00:00",
                "Примечание": "Текст примечания",
                "DT_ID": 2
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить запись в календаре
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
day_id integer (10) Да - ID записи в календаре

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

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

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

{
    "request_identifier": "alphapi.calendar.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Day deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Автозамены
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.autoreplacewords.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 135,
                "Слово": "коробка",
                "Замена": "упаковка"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать адрес
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
address_id integer (10) Да - ID адреса
address_type string (50) Да - Тип адреса
address string (255) Да - Адрес
comment string (255) - Примечание адреса
mask string (305) - Маска поля ввода "Адреса", используется для форматированного ввода текста в поле адрес

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

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

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

{
    "request_identifier": "alphapi.address.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address edited successfully",
    "data": {
        "address_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Маски адресов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.address.masks.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "поставщик",
                "Маска": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы адресов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.address.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "PARENT_TABLE_ID": 6,
                "Тип": "поставщик"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить адрес
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (5) Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer (10) Да - ID сущности
address_type string (50) Да - Тип адреса
address string (255) Да - Адрес
comment string (255) - Примечание адреса
mask string (305) - Маска поля ввода "Адреса", используется для форматированного ввода текста в поле адрес

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

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

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

{
    "request_identifier": "alphapi.address.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address added successfully",
    "data": {
        "address_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Используемые значения адресов с маской ввода
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.address.values.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "PARENT_TABLE_ID": 6,
                "Тип": "поставщик11701000",
                "Адрес": "Москва, пр-т Ленина, 424242"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить адрес
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
address_id integer (10) Да - ID адреса

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

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

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

{
    "request_identifier": "alphapi.address.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Статусы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.doc.statuses.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DS_ID": 3,
                "Статус": "Выполняется"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активные типы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
mode_extended boolean 1 Выдавать массивы в ответе

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

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

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

{
    "request_identifier": "alphapi.doc.types.active.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ROW_ID": 8,
                "DT_ID": 108,
                "Автонумерация": 1,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Все типы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
mode_extended boolean 1 Выдавать массивы в ответе

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

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

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

{
    "request_identifier": "alphapi.doc.types.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ROW_ID": 8,
                "DT_ID": 108,
                "Автонумерация": 1,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "Цвет": 13434,
                "БлокЦвета": 1,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступы к типам документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.doc.types.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "ACCESS_ID": 124,
                "DT_ID": 2,
                "PROVIDER_TABLE_ID": 3,
                "PROVIDER_ID": 5,
                "RECIPIENT_TABLE_ID": 7,
                "RECIPIENT_ID": 99,
                "Источник": "Пользователи",
                "Объект": "Андрей П",
                "Родитель": "Андрей П",
                "Примечание": "Бухгалтер"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Параметры типов документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
DT_ID integer[] Да - Массив идентификаторов типов документов

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

{
    "token": "unique_token_for_30_minutes",
    "DT_ID": [
        104,
        105
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.types.mask.params.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DT_ID integer (10) ID типа документа
— — CAN_USE_AI boolean (1) Признак возможности генерации через AI
— — Активен boolean (1) Флаг активности
— — Номер integer (3) Нумерация
— — Название string (50) Название
— — Группа integer (3) Группа
— — Тип string (50) Тип
— — Маска string (480) Маска
— — Обязательный boolean (1) Признак обязательности
— — Справочник boolean (1) Параметр является справочником
— — Связанный boolean (1) Параметр является связанным
— — Длина integer (10) Длина поля

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

{
    "request_identifier": "alphapi.doc.types.mask.params.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 2.",
    "data": {
        "count": 2,
        "items": [
            {
                "DT_ID": 104,
                "CAN_USE_AI": 0,
                "Активен": 1,
                "Номер": 1,
                "Название": "Исх.номер",
                "Группа": 1,
                "Тип": "Строка",
                "Маска": "Cccccccccccccccccccc",
                "Обязательный": 1,
                "Справочник": 0,
                "Связанный": 0,
                "Длина": 20
            },
            {
                "DT_ID": 104,
                "CAN_USE_AI": 0,
                "Активен": 1,
                "Номер": 1,
                "Название": "Дата",
                "Группа": 2,
                "Тип": "Строка",
                "Маска": "<>00.00<>\\.2\\000",
                "Обязательный": 1,
                "Справочник": 0,
                "Связанный": 1,
                "Длина": 10
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
140 Метод "%s" не поддерживает параметры: %s
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Тип документа с ID "%s" не содержит параметров
Типы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
mode_extended boolean 0 Выдавать массивы в ответе

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

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

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

{
    "request_identifier": "alphapi.doc.types.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ROW_ID": 8,
                "DT_ID": 108,
                "Автонумерация": 1,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
DT_ID integer (10) Да - ID типа документа
Нумерация integer (10) - Текущее значение счетчика журнала, если число отрицательное, то автоматическая регистрация документов с данным типом отключена.
Шаблон string (50) - Шаблон формата регистрационного номера для данного типа документа в журнале при регистрации, где можно использовать тег <!{Номер}> для указания места установки порядкового номера документа
Активен boolean (1) - Флаг активности
Название string (50) - Название
Описание string (255) - Описание
Маска string (480) - Маска
Параметры string (1024) - Если используется маска ввода для типа документа, в данном поле описываются параметры, которые запрограммированы в маске ввода. Строка вида {P1}&{P2}, где P1 - это строка вида {Название параметра}&{Номер параметра}&{Тип параметра}
Примечание string (255) - Примечание
DOC_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID документов, доступных для использования с этим типом документов. Возможны также значения: #-1# - без маршрута по умолчанию; #-2# - новый маршрут по умолчанию
P_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID проектов, доступных для использования с этим типом документов.
LT_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID типов ссылок, доступных для использования с этим типом документов.
Цвет integer (10) - Цветовой тег типа документа, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736

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

{
    "token": "unique_token_for_30_minutes",
    "DT_ID": 111,
    "Нумерация": 5,
    "Шаблон": "<!{Номер}>",
    "Название": "Документ",
    "Описание": "Применяется при регистрации общих документов.",
    "Маска": null,
    "Параметры": null,
    "Примечание": null,
    "DOC_IDS": "#123##54#",
    "P_IDS": null,
    "LT_IDS": null,
    "Цвет": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.type.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.type.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type edited successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить статус активности типа документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
activate integer (0, 1) Да - 0 - деактивировать, 1 - активировать

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

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

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

{
    "request_identifier": "alphapi.doc.type.activation.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type activation set successfully",
    "data": {
        "dt_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать значение параметра маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer Да - ID типа документа
number integer Да - Номер параметра
value string (255) Да - Новое значение параметра
old_value string (255) Да - Старое значение параметра
comment string (255) - Комментарий

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

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Mask param value edited successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Тип документа с ID "%s" не найден
1001 Маска(mask) документа пуста
1002 Номер(number) параметра не найден в маске
1003 Ошибка определения значения(value) параметра в маске
1004 Значение(value) параметра больше разрешенной длины в маске
Часто используемые значения параметра маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
number integer (10) Да - Номер параметра
count integer (10) Да - Количество строк
value string (255) - Значение параметра

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 104,
    "number": 1,
    "count": 50,
    "value": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.type.mask.param.values.frequent Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей
— items Массив элементов
— — Значение string (480) Значение
— — Текст string (480) Текст

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.frequent",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 3.",
    "data": {
        "count": 3,
        "items": [
            {
                "Значение": "Мужской",
                "Текст": "Мужской"
            },
            {
                "Значение": "Женский",
                "Текст": "Женский"
            },
            {
                "Значение": "Средний",
                "Текст": "Средний"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Тип документа с ID "%s" не содержит параметров
1003 Тип документа с ID "%s" не содержит параметра %u. Максимальное кол-во %u
Добавить значение параметра маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer Да - ID типа документа
number integer Да - Номер параметра
value string (255) Да - Значение параметра
comment string (255) - Комментарий

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

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Mask param value added successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Тип документа с ID "%s" не найден
1001 Маска(mask) документа пуста; Язык базы данных не распознан
1002 Номер(number) параметра не найден в маске
1003 Ошибка определения значения(value) параметра в маске
1004 Значение(value) параметра больше разрешенной длины в маске
Значения параметра маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
dt_id integer (10) Да - ID типа документа
number integer (10) Да - Номер параметра

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

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 3.",
    "data": {
        "count": 3,
        "items": [
            {
                "ID": 10001,
                "Значение": "Мужской",
                "Текст": "Мужской",
                "Примечание": ""
            },
            {
                "ID": 10002,
                "Значение": "Женский",
                "Текст": "Женский",
                "Примечание": ""
            },
            {
                "ID": 10003,
                "Значение": "Средний",
                "Текст": "Средний",
                "Примечание": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Тип документа с ID "%s" не содержит параметров
1003 Тип документа с ID "%s" не содержит параметра %u. Максимальное кол-во %u
Удалить значение параметра маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer Да - ID типа документа
number integer Да - Номер параметра
value string (255) Да - Удаляемое значение параметра

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

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Mask param value deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Тип документа с ID "%s" не найден
1001 Маска(mask) документа пуста
1002 Номер(number) параметра не найден в маске
1003 Ошибка определения значения(value) параметра в маске
Добавить тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
Нумерация integer (10) - Текущее значение счетчика журнала, если число отрицательное, то автоматическая регистрация документов с данным типом отключена.
Шаблон string (50) - Шаблон формата регистрационного номера для данного типа документа в журнале при регистрации, где можно использовать тег <!{Номер}> для указания места установки порядкового номера документа
Название string (50) - Название
Описание string (255) - Описание
Маска string (480) - Маска
Параметры string (1024) - Если используется маска ввода для типа документа, в данном поле описываются параметры, которые запрограммированы в маске ввода. Строка вида {P1}&{P2}, где P1 - это строка вида {Название параметра}&{Номер параметра}&{Тип параметра}
Примечание string (255) - Примечание
DOC_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID документов, доступных для использования с этим типом документов. Возможны также значения: #-1# - без маршрута по умолчанию; #-2# - новый маршрут по умолчанию
P_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID проектов, доступных для использования с этим типом документов.
LT_IDS string - Строка типа #ХХХ##YYY#", где передаются экранированные символом # ID типов ссылок, доступных для использования с этим типом документов.
Цвет integer (10) - Цветовой тег типа документа, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736

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

{
    "token": "unique_token_for_30_minutes",
    "Нумерация": 5,
    "Шаблон": "<!{Номер}>",
    "Название": "Документ",
    "Описание": "Применяется при регистрации общих документов.",
    "Маска": null,
    "Параметры": null,
    "Примечание": null,
    "DOC_IDS": "#123##54#",
    "P_IDS": null,
    "LT_IDS": null,
    "Цвет": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.type.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— dt_id integer (10) ID типа документа

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

{
    "request_identifier": "alphapi.doc.type.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type added successfully",
    "data": {
        "dt_id": 111
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа

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

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

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

{
    "request_identifier": "alphapi.doc.type.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать банковский счет
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
account_id integer (10) Да - ID счета
parent_table_id integer (10) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
bank_name string (255) Да - Название банка
bik string (9) Да - Банковский идентификационный код
kc string (20) Да - Корреспондентский счет
account string (20) Да - Расчетный счет
comment string (2048) - Комментарий

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

{
    "token": "unique_token_for_30_minutes",
    "account_id": 777,
    "parent_table_id": 11,
    "parent_id": 113,
    "bank_name": "Тинькофф",
    "bik": "123456789",
    "kc": "12345678901234567890",
    "account": "34534567890123456789",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.bankdetails.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— account_id integer (10) ID счета

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

{
    "request_identifier": "alphapi.clients.bankdetails.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "account_id": 777
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить банковский счет
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (10) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
bank_name string (255) Да - Название банка
bik string (9) Да - Банковский идентификационный код
kc string (20) Да - Корреспондентский счет
account string (20) Да - Расчетный счет
comment string (2048) - Комментарий

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 11,
    "parent_id": 113,
    "bank_name": "Тинькофф",
    "bik": "123456789",
    "kc": "12345678901234567890",
    "account": "34534567890123456789",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.bankdetails.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— account_id integer (10) ID счета

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

{
    "request_identifier": "alphapi.clients.bankdetails.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "account_id": 777
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить банковский счет
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
account_id integer (10) Да - ID счета

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

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

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

{
    "request_identifier": "alphapi.clients.bankdetails.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Исполнители
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
rp_id integer (10) - ID точки маршрута

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 150,
    "where": "CustomKey = '1.1071'",
    "orderby": "CustomKey ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.routepoints.responsibles.directory.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — CustomKey string (1023) Составной идентификатор, уникальный в рамках данного справочника
— — RESPONSIBLE_TABLE_ID integer (3) ID таблицы сущности исполнителя (пользователь/должность/группа)
— — RESPONSIBLE_ID integer (3) ID сущности исполнителя (пользователь/должность/группа)
— — Сервер integer (3) Номер сервера АЛЬФА ДОК, где был создан логин
— — Исполнитель string (255) Исполнитель данной точки маршрута (должность/группа/пользователь)
— — Должность string (255) Название должности
— — ФИО string (255) Ф.И.О. пользователя
— — LOGIN_ID integer (10) ID пользователя

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

{
    "request_identifier": "alphapi.docs.routepoints.responsibles.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1071",
                "RESPONSIBLE_TABLE_ID": 101,
                "RESPONSIBLE_ID": 10,
                "Сервер": 1,
                "Исполнитель": "Сидоров С.С.",
                "Должность": "Директор",
                "ФИО": "Сидоров С.С.",
                "LOGIN_ID": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество проектов текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.projects.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My projects count is 2",
    "data": {
        "items": {
            "my_projects_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество распечаток текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.prints.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My prints count is 2",
    "data": {
        "items": {
            "my_prints_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать правовую форму
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
lf_id integer (10) Да - ID правовой формы
legal_form_name string (50) Да - Название правовой формы
legal_form_name_full string (255) Да - Полное название правовой формы
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.legalforms.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form edited successfully",
    "data": {
        "lf_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить правовую форму
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
legal_form_name string (50) Да - Название правовой формы
legal_form_name_full string (255) Да - Полное название правовой формы
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.legalforms.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form added successfully",
    "data": {
        "lf_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить правовую форму
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
lf_id integer (10) Да - ID правовой формы

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

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

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

{
    "request_identifier": "alphapi.legalforms.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Подразделения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.subunits.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Подразделение": "Бухгалтерия"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Статусы точек маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.commissions.route.point.statuses.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "RPS_ID": 5,
                "Название": "Завершено",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные маршруты для типов документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "DOC_ID = 'A'",
    "orderby": "DOC_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.stroutes.x.doc.types.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DOC_ID integer (10) ID маршрута/документа
— — DT_ID integer (10) ID типа документа
— — Содержание string (255) Содержание маршрута

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

{
    "request_identifier": "alphapi.stroutes.x.doc.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 1012,
                "DT_ID": 2,
                "Содержание": "Маршрут для типа документа"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Распечатки с полным текстом
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.prints.ntext.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 46,
                "PRINT_ID": 12,
                "Номер": 12,
                "Тип": "Нестандартный",
                "Описание": "Распечатка документа",
                "Дата": "2026-01-20 11:22:33",
                "Пользователь": "Разработчик",
                "Примечание": "Пример",
                "Текст": "Полный текст распечатки"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Поручения
Статус пересчета кеша поручений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.routepoints.snapshot.status Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Статус задания
— status string (8) Статус: progress, error или done
— progress integer (3) Процент выполнения
— date_start datetime (Y-m-d H:i:s) Дата и время запуска
— date_end datetime (Y-m-d H:i:s) Дата и время окончания
— message string (2048) Сообщение о ходе выполнения или ошибке

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

{
    "request_identifier": "alphapi.routepoints.snapshot.status",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Статус пересчета кеша поручений получен",
    "data": {
        "status": "progress",
        "progress": 50,
        "date_start": "2026-09-03 10:00:00",
        "date_end": null,
        "message": "50%"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Задание на обновление кеша поручений не найдено
Поручения кеш
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.snapshot.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 101990,
                "DOC_ID": 101002,
                "DT_ID": 1,
                "CONTROLLER_ID": 102,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 102,
                "LOGIN_ID": 105,
                "RPT_ID": 2,
                "RPS_ID": 1,
                "PARENTS": "#101990#",
                "LINKS": "#102101#",
                "Тип документа": "Документ",
                "Документ": 101002,
                "Дата": "2022-03-25 13:12:27",
                "Контролер": "Разработчик",
                "Регистратор": "Разработчик",
                "Проект": "проект1",
                "Содержание": "Тип:тип1; Тема:0001-0002-0001-тема2 -вопрос2; Получ.:почта; Пов.:да ; Отв.:ответ2;",
                "Исполнен": null,
                "Регистрация": null,
                "Рег.номер": "Тест951406",
                "Тип": "Согласование",
                "Старт": "2022-03-25 13:20:31",
                "Срок": "2022-03-30 13:20:31",
                "Дней": 5,
                "Исполнено": null,
                "Выполнено": null,
                "Исполнитель": "Менеджеры \/Разработчик\/",
                "ИсполнительФИО": "Разработчик",
                "Статус": "Остановлено",
                "Описание": "контент 759846",
                "Примечание": "контент 164656",
                "Комментарий": null,
                "Индикатор": -866,
                "Активен": 0,
                "Создана": "2022-03-25 13:12:27",
                "Родитель": 101000
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Пересчитать кеш поручений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.routepoints.snapshot.refresh",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Пересчет кеша поручений запущен"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Обновление кеша поручений уже запущено
Поручения Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 10230,
                "DOC_ID": 10125,
                "Раздел": "Точки маршрутов",
                "Объект": "Согласование ДС №15 от 01.04.2019",
                "Дата": "2019-08-07 12:08:35",
                "Индекс": "Согласование ДС №15 от 01.04.2019Иванова Екатерина"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Поручения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 101990,
                "DOC_ID": 101002,
                "DT_ID": 1,
                "CONTROLLER_ID": 102,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 102,
                "LOGIN_ID": 105,
                "RPT_ID": 2,
                "RPS_ID": 1,
                "PARENTS": "#101990#",
                "LINKS": "#102101#",
                "Тип документа": "Документ",
                "Документ": 101002,
                "Дата": "2022-03-25 13:12:27",
                "Контролер": "Разработчик",
                "Регистратор": "Разработчик",
                "Проект": "проект1",
                "Содержание": "Тип:тип1; Тема:0001-0002-0001-тема2 -вопрос2; Получ.:почта; Пов.:да ; Отв.:ответ2;",
                "Исполнен": null,
                "Регистрация": null,
                "Рег.номер": "Тест951406",
                "Тип": "Согласование",
                "Старт": "2022-03-25 13:20:31",
                "Срок": "2022-03-30 13:20:31",
                "Дней": 5,
                "Исполнено": null,
                "Выполнено": null,
                "Исполнитель": "Менеджеры \/Разработчик\/",
                "ИсполнительФИО": "Разработчик",
                "Статус": "Остановлено",
                "Описание": "контент 759846",
                "Примечание": "контент 164656",
                "Комментарий": null,
                "Индикатор": -866,
                "Активен": 0,
                "Создана": "2022-03-25 13:12:27",
                "Родитель": 101000
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Согласовать точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.accept",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point accepted successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Остановить точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as stoped successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Подтвердить выполнение поручения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.confirm",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as confirmed successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Отметить точку маршрута как взятую
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.taken",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point taken successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Отметить уведомление как прочитанное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as viewed successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Вернуть поручение на доработку
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.return",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as returned successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Отчитаться о выполнении поручения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.finish",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as finished successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Пометить прочитанной точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.read",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as read successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Отклонить точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
comment string (2048) - Текст резолюции/комментария
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.decline",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point declined successfully",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Установить исполнителя поручения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
responsible_table_id integer (3) Да - ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да - ID сущности исполнителя (пользователь/должность/группа)

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.responsible.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point responsible set successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество всего поручений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.docs.routespoints.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My docs routespoints count is 115",
    "data": {
        "items": {
            "my_docs_routespoints_count": 115
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество новых поручений пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.new.commissions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My new commissions count is 2",
    "data": {
        "items": {
            "my_new_commissions_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество поручений пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.commissions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My commissions count is 2",
    "data": {
        "items": {
            "my_commissions_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Поручения
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.commissions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DT_ID": 101,
                "Тип документа": "Документ",
                "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
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Счетчик поручений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.commissions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Counter of documents under control",
    "data": {
        "count": 123,
        "count_new": 12,
        "count_expired": 1,
        "ids": [
            101,
            102,
            103
        ],
        "ids_new": [
            101,
            102,
            103
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Цвета поручений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.commissions.colors.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 5512,
                "Цвет": 123234,
                "БлокЦвета": 0
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контроль
Документы на контроле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.control.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DOC_ID": 101,
                "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": "",
                "Новое": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы документов на контроле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.control.docs.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DT_ID": 31,
                "Тип": "Первый тип"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Счетчик документов на контроле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.control.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer (10) Общее кол-во
— count_new integer (10) Кол-во новых
— count_expired integer (10) Кол-во просроченных
— ids integer[] Массив ID документов
— ids_new integer[] Массив 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
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Цвета документов на контроле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Цвет = 'A'",
    "orderby": "Цвет ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.uc.colors.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DOC_ID integer (10) ID документа
— — Цвет integer (10) Код цвета документа в десятичной кодировке
— — БлокЦвета integer (10) Флаг блокировки цвета, может ли пользователь менять цвет
— — ЦветИсточник string (255) Описание источника цвета документа

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

{
    "request_identifier": "alphapi.docs.uc.colors.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DOC_ID": 5512,
                "Цвет": 123234,
                "БлокЦвета": 0,
                "ЦветИсточник": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество изменившихся документов на контроле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.changeddocs.uc.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My changed docs under control count is 2",
    "data": {
        "items": {
            "my_changed_docs_uc_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество документов на контроле у пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.docs.uc.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My docs under control count is 2",
    "data": {
        "items": {
            "my_docs_uc_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Документы
Проверка существования документа в БД
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 5,
    "where": "Тип = 'A'",
    "orderby": "Тип ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.check.id Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DOC_ID integer (10) ID документа
— — Тип string (50) Тип
— — Содержание string (255) Содержание документа
— — Доступен boolean (1) Доступен
— — Найдено integer (10) Найдено

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

{
    "request_identifier": "alphapi.doc.check.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 5,
                "Тип": "Документ",
                "Содержание": "Документ ООО АльфаДок",
                "Доступен": 1,
                "Найдено": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить данные документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.data",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DOC_ID": 101,
                "REGISTRAR_ID": 101,
                "CONTROLLER_ID": 101,
                "DS_ID": 101,
                "DT_ID": 101,
                "Тип": "Уведомление",
                "Активен": 1,
                "Статус": "Просрочен",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Договора",
                "Содержание": "Содержание документа",
                "Содержание_MASK": "",
                "Содержание_MASK_PARAMS": "",
                "Содержание_MASK_COND": "DT_ID=101",
                "Запуск": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "101",
                "Комментарий": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
403 Нет доступа для документа
404 Документ не существует
Проверить наличие документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
query string (255) Да - Поисковая фраза
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.doc.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 5,
                "Тип": "Документ",
                "Содержание": "Документ ООО АльфаДок",
                "Доступен": 1,
                "Найдено": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит справочников документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.directories.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 33050,
                "Раздел": "Типы документов",
                "Объект": "Входящий",
                "Дата время": "2024-04-10 15:40:37",
                "Параметр01": "Группы пользователей",
                "Параметр02": "Все пользователи",
                "Станция": "ALPHAXP",
                "Пользователь": "Developer-1 \/Разработчик\/",
                "Приоритет события": 0,
                "Событие": "Добавление доступа к типу документа"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Приоритеты непрочитанных событий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer (10) - ID документа

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

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

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

{
    "request_identifier": "alphapi.docs.unread.events.priorities.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Приоритет": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) Да 1000 Ограничить кол-во записей. Максимально допустимое значение: 1000
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.audit.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1234567890,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Контролер": "Ремесленников Р.Р.",
                "Регистратор": "Дорофеев Д.Д.",
                "Дата время": "2001-01-01 01:01:01",
                "Параметр01": "Спасибо. Выполнено",
                "Параметр02": "Успешно, ID 10238",
                "Станция": "ALPHA101",
                "Пользователь": "Логин пользователя",
                "Приоритет события": 2,
                "Событие": "Добавить комментарий",
                "Элемент": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
114 Переданный лимит не может быть выше %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Уникальное содержание документов пользователя по типам
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.contents.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "ID": 1099,
                "DT_ID": 1,
                "Содержание": "текст",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Реестр документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DOC_ID": 102,
                "DT_ID": 1,
                "CONTROLLER_ID": 105,
                "Активен": 1,
                "Тип": "Документ",
                "Номер": 102,
                "Дата": "2022-03-24 12:54:17",
                "Контролер": "Разработчик",
                "Регистратор": "Разработчик",
                "Проект": "проект1954400",
                "Содержание": "текст",
                "Срок": null,
                "Исполнен": "2022-03-24 12:54:21",
                "Комментарий": "коммент129100",
                "Рег.номер": "Тест\/$%#!\"&400635",
                "Регистрация": "2022-03-21 00:00:00"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Просмотры документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.views.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "KEY_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Документ": 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",
                "Активно": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Документы без справочников
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
include_mask_params boolean false Включить параметры масок

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Содержание = 'A'",
    "orderby": "Содержание ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false,
    "include_mask_params": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.int.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — ROW_ID integer (10) ID записи
— — DOC_ID integer (10) ID документа
— — DT_ID integer (10) ID типа документа
— — P_ID integer (10) ID проекта
— — REGISTRAR_ID integer (10) ID логина пользователя, создавшего документ
— — CONTROLLER_ID integer (10) ID логина пользователя контролера документа
— — Дата datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Активен boolean (1) Флаг активности документа (документ может быть неактивным, если это черновик или на паузе)
— — Содержание string (255) Содержание документа
— — Комментарий string (255) Комментарий документа
— — ПГ datetime (Y-m-d H:i:s) ПГ
— — Запуск datetime (Y-m-d H:i:s) Дата автоматического запуска документа в работу, если установлен отсроченный запуск
— — Регистрация datetime (Y-m-d H:i:s) Дата регистрации документа, если эта функция используется
— — Номер varchar (50) Номер
— — Progress varchar (1024) Progress
— — Черновик boolean (1) Черновик
— — MASK_PARAMS Массив параметров масок (при указанном параметре "include_mask_params")
— — — number integer (10) Номер параметра
— — — group integer (10) Группа параметра
— — — name string (255) Именование параметра
— — — type string (255) Тип
— — — mask string (255) Маска
— — — value string (255) Значение

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

{
    "request_identifier": "alphapi.docs.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ROW_ID": 10,
                "DOC_ID": 1021,
                "DT_ID": 1,
                "P_ID": 1012,
                "REGISTRAR_ID": 102,
                "CONTROLLER_ID": 102,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Активен": true,
                "Содержание": "Текст",
                "Комментарий": "коммент",
                "ПГ": "2001-01-01 01:01:01",
                "Запуск": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Номер": "Тест3234",
                "Progress": "#1041##1042##1044#",
                "Черновик": false,
                "MASK_PARAMS": [
                    {
                        "number": 1,
                        "group": 1,
                        "name": "Получатель",
                        "type": "RTRIM(REPLACE(%s,'  ',''))",
                        "mask": "cccccccccc-ccccccccccc-cccccc",
                        "value": "Иванов П.С."
                    }
                ]
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Внешние ссылки документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.el.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 1,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 12345,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Стандартный",
                "Содержание": "Текст",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Пункт": "EXT-001",
                "Пользователь": "Иванов И.И.",
                "Наименование": "",
                "Ответственный": "",
                "Окончание": "",
                "Примечание": "Комментарий",
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Документы документов
URL:
Эмулятор
Комментарии/резолюции документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.comments.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С.",
                "Элемент": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Кросс-ссылки
URL:
Эмулятор
Цвета документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) - ID документа
login_id integer (10) - ID пользователя
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "login_id": 15,
    "where": "ЦветИсточник = 'A'",
    "orderby": "ЦветИсточник ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.color.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DOC_ID integer (10) ID документа
— — Цвет integer (10) Цвет
— — БлокЦвета integer (10) Блок цвета
— — ЦветИсточник string (255) Цвет источник

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

{
    "request_identifier": "alphapi.docs.color.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DOC_ID": 101,
                "Цвет": 143,
                "БлокЦвета": 15,
                "ЦветИсточник": "проект"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Документы. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "DOC_ID": 101011,
                "Раздел": "Документы",
                "Объект": "текст",
                "Индекс": "101011текстРазработчикпроект1475882",
                "Дата": "2022-04-08 10:13:17"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Документы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DOC_ID": 101,
                "REGISTRAR_ID": 101,
                "CONTROLLER_ID": 101,
                "DS_ID": 101,
                "DT_ID": 101,
                "Тип": "Уведомление",
                "Активен": 1,
                "Статус": "Просрочен",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Договора",
                "Содержание": "Содержание документа",
                "Содержание_MASK": "",
                "Содержание_MASK_PARAMS": "",
                "Содержание_MASK_COND": "DT_ID=101",
                "Запуск": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "101",
                "Комментарий": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Содержимое файлов. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.content.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 28,
                "F_ID": 101,
                "DOC_ID": 103,
                "Раздел": "Содержание файлов",
                "Объект": "test9652953 - текст291970",
                "Дата": "2022-03-24 12:55:43",
                "Индекс": "документ справка"
            }
        ]
    }
}
Описание
Поиск по содержимому файлов
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 101,
                "Активен": 1,
                "Документ": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название_файла.docx",
                "Редакция": 1,
                "Пользователь": "Сидоров С.С.",
                "Атрибуты": "",
                "Примечание": null,
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Индикатор": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы подписей документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.signs.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 101,
                "PARENT_ID": 101,
                "LOGIN_ID": 102,
                "Активен": 1,
                "НомерДокумента": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название файла",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": "Примечание к файлу",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Атрибуты": "",
                "Размер": 12345
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы документов. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 28,
                "F_ID": 101,
                "DOC_ID": 103,
                "Раздел": "Файлы",
                "Объект": "test9652953 - текст291970",
                "Дата": "2022-03-24 12:55:43",
                "Индекс": "test9652953Разработчик"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Нескопированные файлы документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.notcopied.all.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 101,
                "PARENT_ID": 101,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название файла",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": "Примечание к файлу",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
ЭП файлов документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_ids integer[] Да - Массив идентификаторов документов

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

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

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

{
    "request_identifier": "alphapi.docs.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 1010,
                "Номер": 1,
                "Файл": "Документ.pdf",
                "Редакция": 2,
                "Пользователь": "Иванов И.И.",
                "ЭП": 0.88
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Процент выполнения документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.progress.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 101,
                "Выполнение": 50
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.docs.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My docs count is 2",
    "data": {
        "items": {
            "my_docs_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Документ
Запросить отчет
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
id integer (3) - ID сущности, для которой строится отчет
f_id integer (3) - ID файла шаблона отчета

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

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

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

{
    "request_identifier": "alphapi.dashboard.docreport.request",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc report request successfully",
    "data": {
        "request_id": "sd8FAAS97T239g7W454trf45jferdxz"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить свободный номер документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
reg_number string (255) Да - Регистрационный номер документа

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

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

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

{
    "request_identifier": "alphapi.regnumber.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is 1",
    "data": {
        "items": {
            "result": 1
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Остановить документ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты
doc_id integer (10) Да - ID документа
comment string (2048) - Текст резолюции
comment_markdown string (2048) - Комментарий с markdown-разметкой

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

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

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

{
    "request_identifier": "alphapi.doc.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document stoped successfully",
    "data": {
        "doc_id": 101,
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Редактировать документ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
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 (10) - Цветовой тег документа, цвет передается в кодировке R255+G255+B255
color_is_locked boolean false Признак блокировки цвета
mask_params varchar[] - Массив параметров содержания документа

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "dt_id": 101,
    "p_id": 101,
    "controller_id": 101,
    "plan_end_date": "2025-12-01",
    "content": "Текст",
    "comment": "Комментарий",
    "pg": "2025-12-01",
    "start": "2025-12-01",
    "reg_date": "2025-12-01",
    "reg_number": "123\/4",
    "color": 1134,
    "color_is_locked": false,
    "mask_params": [
        "Значение первого параметра содержания",
        "Значение второго параметра содержания"
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— doc_id integer (10) ID документа

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

{
    "request_identifier": "alphapi.doc.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Параметры документа не переданы
1003 Некорректный тип параметра #%s документа. Должен быть "%s"
1004 Параметр содержания #%u не соответствует маске
1005 Параметр содержания #%s содержит несуществующее значение "%s"
1006 Параметр содержания #%u превышает максимальную длину %s
1007 Параметр содержания #%u содержит некорректную дату "%s"
1008 Параметр содержания #%u после подстановки маски изменил значение. Было "%s", стало "%s"
1009 Маска, выбранная для параметра #%u, подразумевает ввод даты с 2000 по 2099 год
1011 Цвет задается строго положительным числом
Получить количество непрочтенных событий документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.unread.events.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Unread events count type is 2",
    "data": {
        "items": {
            "unread_events_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить доступ к связанному документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
linked_doc_id integer (10) Да - ID связанного документа

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

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

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

{
    "request_identifier": "alphapi.doc.linked.doc.access",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Access to linked doc checked"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить дату остановки документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.stopdate.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document stop date is 2022-12-31 15:35:17",
    "data": {
        "items": {
            "doc_stop_date": "2022-12-31 15:35:17"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Счетчики для документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.counters",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Incorrect text identifier \"counter_of_documents_success\".",
    "data": {
        "comments_count": 55,
        "files_count": 12,
        "links_count": 1,
        "contractor_count": 6,
        "views_count": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить дату документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 104
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.date.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— doc_date datetime (Y-m-d H:i:s) Дата документа

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

{
    "request_identifier": "alphapi.doc.date.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document date is 2022-03-30 15:51:07",
    "data": {
        "items": {
            "doc_date": "2022-03-30 15:51:07"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить информацию о недавних просмотрах документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.views.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document views are successfully returned",
    "data": {
        "items": {
            "doc_views": "21.08.2025 14:35:38(Иванов И.)->21.08.2025 10:23:12(Петров П.)"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Зарегистрировать документ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
reg_number string (50) - Регистрационный номер (необязательно)
reg_date datetime (YYYY-MM-DD HH:mm:ss) - Дата регистрации (необязательно)

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

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

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

{
    "request_identifier": "alphapi.doc.register",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document registered successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать внешнюю ссылку
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
link_id integer (10) Да - ID ссылки
doc_id integer (10) Да - ID документа
code string (20) Да - Код внешней ссылки

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

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

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

{
    "request_identifier": "alphapi.doc.el.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "External link edited successfully",
    "data": {
        "link_id": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить внешнюю ссылку
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
code string (20) Да - Код внешней ссылки

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

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

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

{
    "request_identifier": "alphapi.doc.el.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "External link added successfully",
    "data": {
        "link_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить проект/папку документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
p_id integer (10) Да - ID проекта

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

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

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

{
    "request_identifier": "alphapi.doc.project.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc project set successfully",
    "data": {
        "doc_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
doc_id integer (10) Да - ID документа
rpt_id integer (10) Да - ID типа точки маршрута (1 - Поручение, 2 - Согласование, 3 - Уведомление)
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": 1,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— rp_id integer (10) ID точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point edited successfully",
    "data": {
        "rp_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
rpt_id integer (10) Да - ID типа точки маршрута (1 - Поручение, 2 - Согласование, 3 - Уведомление)
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": 1,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— rp_id integer (10) ID точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point added successfully",
    "data": {
        "rp_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить точку маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Routepoint deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Запустить или поставить документ на паузу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (1, 10) Да - ID документа
active integer (0, 1) Да - 0 - на паузу, 1 - запуск

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

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

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

{
    "request_identifier": "alphapi.doc.activation.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить ссылки
URL:
Эмулятор
Документы документа
URL:
Эмулятор
Добавить доступ к документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.doc.access.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc access added successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить доступ к документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.doc.access.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc access deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Назначить код
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
code_id integer (10) Да - ID штрих-кода
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.code.assign",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Code assigned successfully.",
    "data": {
        "cp_id": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать ссылку
URL:
Эмулятор
Добавить ссылку
URL:
Эмулятор
Удалить ссылку
URL:
Эмулятор
Типы документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer Да - ID документа
mode_extended boolean 1 Выдавать массивы в ответе

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "mode_extended": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.types.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DT_ID integer (10) ID типа документа
— — Название string (50) Название
— — Маска string (480) Маска
— — Шаблон string (50) Шаблон
— — Автонумерация boolean (1) Флаг автоматической нумерации
— — Нумерация integer (10) Нумерация
— — P_ID_default integer (10) Проект, в который по умолчанию относятся документы данного типа
— — DOC_ID_default integer (10) Маршрут по умолчанию для данного типа документа
— — DOC_IDS integer[] Доступные стандартные маршруты для данного типа документа (только в режиме mode_extended = 1)
— — P_IDS integer[] Проекты, которые доступны для документов данного типа документа (только в режиме mode_extended = 1)
— — LT_IDS integer[] Типы ссылок по умолчанию (только в режиме mode_extended = 1)

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

{
    "request_identifier": "alphapi.doc.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DT_ID": 108,
                "Название": "Документ",
                "Маска": "Строка\\:Ccccc\\; Целое\\:0##\\; Дробное\\:0####\\; Дата\\:<>00.00<>\\.2\\000\\; Время\\:<>00:00<>\\; Справочник\\:<>Ccccccc<>\\;",
                "Шаблон": "<!{Номер}>",
                "Автонумерация": 1,
                "Нумерация": 5,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Пометить документ как прочитанный
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить дату запуска документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
start_date date (YYYY-MM-DD) Да - Дата запуска документа

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

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

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

{
    "request_identifier": "alphapi.doc.startdate.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Start date set successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Сбросить дату запуска документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.startdate.unset",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Start date unset successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить черновик документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
p_id integer (10) Да - ID проекта документа
controller_id integer (10) Да - ID пользователя контролера документа
plan_end_date date (YYYY-MM-DD) - Срок документа
content text (255) - Содержание документа. Обязательно для некоторых типов документов
comment text (255) - Комментарий документа
pg date (YYYY-MM-DD) - План-график (рудимент)
start date (YYYY-MM-DD) - Дата планового запуска документа в работу
reg_date date (YYYY-MM-DD) - Дата регистрации документа
reg_number varchar (50) - Регистрационный номер документа
color integer (4) - Цветовой тег документа, цвет передается в кодировке R255+G255+B255
color_is_locked boolean false Признак блокировки цвета
mask_params varchar[] - Массив параметров содержания документа

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 1,
    "p_id": 101,
    "controller_id": 101,
    "plan_end_date": "2025-12-01",
    "content": "Текст",
    "comment": "Комментарий",
    "pg": "2025-12-01",
    "start": "2025-12-01",
    "reg_date": "2025-12-01",
    "reg_number": "123\/4",
    "color": 1134,
    "color_is_locked": false,
    "mask_params": [
        "Значение первого параметра содержания",
        "Значение второго параметра содержания"
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— doc_id integer (10) ID документа

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

{
    "request_identifier": "alphapi.doc.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Параметры документа не переданы
1003 Некорректный тип параметра #%s документа. Должен быть "%s"
1004 Параметр содержания #%u не соответствует маске
1005 Параметр содержания #%s содержит несуществующее значение "%s"
1006 Параметр содержания #%u превышает максимальную длину %s
1007 Параметр содержания #%u содержит некорректную дату "%s"
1008 Параметр содержания #%u после подстановки маски изменил значение. Было "%s", стало "%s"
1009 Маска, выбранная для параметра #%u, подразумевает ввод даты с 2000 по 2099 год
1011 Цвет задается строго положительным числом
Получить дату последнего прочтения документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 104
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.last.read.event.datetime.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— doc_last_read_event_datetime datetime (Y-m-d H:i:s) Дата последнего прочтения документа

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

{
    "request_identifier": "alphapi.doc.last.read.event.datetime.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document last read event datetime is 2022-12-31 15:37:16",
    "data": {
        "items": {
            "doc_last_read_event_datetime": "2022-12-31 15:37:16"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Переместить файл в документ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer (1, 10) Да - ID файла
doc_id integer (1, 10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.file.move",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Определить связь с предыдущей редакцией файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
file_name string Да - Полное исходное имя файла

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

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

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

{
    "request_identifier": "alphapi.doc.file.edition.resolve",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "file_id": 101,
        "file_name": "Договор.pdf"
    }
}
Описание
Для длинных имен ищет редакцию по хешу полного имени в поле Файл. Если редакция не найдена, возвращает свободное название длиной до 50 символов с учетом индекса. Для коротких имен используется совпадение по названию. Метод не резервирует выбранное название.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
dt_id integer (10) Да - ID типа документа

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

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

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

{
    "request_identifier": "alphapi.doc.type.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type set successfully",
    "data": {
        "doc_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить доступ к типу документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.doc.type.access.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type access added successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить доступ к типу документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.doc.type.access.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type access deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.type.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document type is 2",
    "data": {
        "items": {
            "doc_type": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Статус архивации файлов документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
job_hash string (36) Да - Идентификатор задания архивации

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

{
    "token": "unique_token_for_30_minutes",
    "job_hash": "12345678-1234-1234-1234-123456789012"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.files.archive.status Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Статус архивации файлов документа
— status string (8) Статус: pending, progress, error или success
— progress integer (3) Процент выполнения
— date_start datetime (Y-m-d H:i:s) Дата и время запуска
— date_end datetime (Y-m-d H:i:s) Дата и время окончания
— message string (2048) Сообщение об ошибке

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

{
    "request_identifier": "alphapi.doc.files.archive.status",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Статус архивации файлов документа получен",
    "data": {
        "status": "progress",
        "progress": 50,
        "date_start": "2026-10-06 10:00:00",
        "date_end": null,
        "message": ""
    }
}
Описание
Статус задания доступен только пользователю, который его запустил, при наличии доступа к документу.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
403 Документ не существует или недоступен
1000 Задание архивации не найдено
Запустить архивацию файлов документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
file_ids integer[] (10) - ID файлов документа. Если параметр отсутствует, архивируются актуальные версии всех файлов. Пустой массив не выбирает файлы

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "file_ids": [
        201,
        202
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.files.archive.start Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Запустить архивацию файлов документа
— job_hash string (36) Идентификатор задания архивации

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

{
    "request_identifier": "alphapi.doc.files.archive.start",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Архивация файлов документа запущена",
    "data": {
        "job_hash": "12345678-1234-1234-1234-123456789012"
    }
}
Описание
Архивация ZIP выполняется асинхронно. Для одного пользователя разрешено одно задание одновременно. Статус и результат доступны по job_hash в течение 24 часов.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
120 Значение поля "%s" должно быть положительным
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
401 Токен неизвестен, либо его срок действия истек.
403 Документ не существует или недоступен
1000 Файл не существует или недоступен в указанном документе
1001 Архивация файлов уже запущена; Нет файлов для архивации
1002 file_ids должен быть массивом положительных целочисленных ID файлов
Получить архив файлов документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
job_hash string (36) Да - Идентификатор задания архивации

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

{
    "token": "unique_token_for_30_minutes",
    "job_hash": "12345678-1234-1234-1234-123456789012"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.files.archive.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Получить архив файлов документа
— file_url string (2048) Полный URL ZIP архива в публичном хранилище для прямого скачивания

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

{
    "request_identifier": "alphapi.doc.files.archive.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Архив файлов документа получен",
    "data": {
        "file_url": "https:\/\/storage.alpha-doc.ru\/web\/6CB4CD53D8CB44BF9107A58D7DBA62F8.zip"
    }
}
Описание
URL архива возвращается после получения статуса success. Результат доступен только пользователю, который запустил задание, при наличии доступа к документу.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
403 Документ не существует или недоступен
1000 Задание архивации не найдено
1001 Архив файлов документа еще не готов
Файлы документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.doc.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 101,
                "PARENT_ID": 101,
                "LOGIN_ID": 125,
                "Активен": 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
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Простые ЭП файлов документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
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 Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — Номер integer (3) Номер файла в документе
— — Файл string (255) Название файла
— — Редакция integer (3) Редакция файла
— — Пользователь string (255) Логин пользователя, который добавил файл
— — ЭП float (255) Метка простой цифровой подписи файла

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

{
    "request_identifier": "alphapi.doc.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 101,
                "Номер": 2,
                "Файл": "Приложение.doc",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "ЭП": -4.94714764660603
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить маршрут
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
DOC_ID integer Да - ID документа
RP_ID integer[] - Массив ID точек маршрута документа, с которого копируем
PARENT_DOC_ID integer Да - ID маршрута или документа, с которого копируем
PARENTS text (255) - Вложенность
InitLINKS text (255) - Входящие связи
routePointsResponsibles Массив параметров для точек маршрута с неопределенным исполнителем
— RESPONSIBLE_TABLE_ID integer Да - Идентификатор таблицы ответственного. Допустимые значения: 1 - Пользователи, 2 - Группы, 48 - Должности, 59 - Системный ID
— RESPONSIBLE_ID integer Да - Идентификатор ответственного
— description string (100) - Описание
— days integer (3) - Срок в рабочих днях (NULL, если срок указывается через точную дату)
— end_date date (YYYY-MM-DD) - Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
— comment string (255) - Комментарий

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

{
    "token": "unique_token_for_30_minutes",
    "DOC_ID": 101,
    "RP_ID": [
        1001,
        1002,
        1003
    ],
    "PARENT_DOC_ID": 100,
    "PARENTS": "",
    "InitLINKS": "",
    "routePointsResponsibles": [
        {
            "RESPONSIBLE_TABLE_ID": 2,
            "RESPONSIBLE_ID": 1,
            "description": "Особое описание",
            "days": null,
            "end_date": "2022-12-31",
            "comment": "Особый комментарий"
        },
        {
            "RESPONSIBLE_TABLE_ID": 1,
            "RESPONSIBLE_ID": 1070,
            "description": "Особое описание 2",
            "days": 2,
            "end_date": null,
            "comment": "Особый комментарий 2"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.route.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.route.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route added successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
129 Неизвестный тип БД
401 Токен неизвестен, либо его срок действия истек.
1000 Исходный документ не найден
1001 Исходный документ не содержит маршрут
1002 В массиве "routePointsResponsibles" допустимы только дни(days), либо дата окончания(end_date)
1003 Дата окончания(end_date) не может быть меньше текущей даты
Проверить у документа наличие активных точек маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.for.activerp.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is 0",
    "data": {
        "items": {
            "result": 0
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить документ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Сменить контролера
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
login_id integer (10) Да - ID логина

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

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

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

{
    "request_identifier": "alphapi.doc.controller.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Controller set successfully",
    "data": {
        "doc_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить предыдущего контролера
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.controller.prev.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить регистрационные данные документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
reg_date datetime (YYYY-MM-DD HH:mm:ss) Да - Дата регистрации
reg_number string (50) Да - Регистрационный номер

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

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

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

{
    "request_identifier": "alphapi.doc.reg.data.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить прямой доступ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
recipient_table_id integer (10) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа
provider_table_id integer (10) Да - ID таблицы источника доступа
provider_id integer (10) Да - ID источника доступа

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

{
    "token": "unique_token_for_30_minutes",
    "recipient_table_id": 2,
    "recipient_id": 2,
    "provider_table_id": 44,
    "provider_id": 104
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.direct.access.check Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— result integer Результат проверки

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

{
    "request_identifier": "alphapi.direct.access.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is 1",
    "data": {
        "items": {
            "result": 1
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные контролеры документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "ФИО = 'A'",
    "orderby": "ФИО ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.controllers.directory.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — LOGIN_ID integer (10) ID пользователя контролёра документа
— — ФИО string (255) ФИО контролёра документа

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

{
    "request_identifier": "alphapi.docs.controllers.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LOGIN_ID": 101,
                "ФИО": "Иванов Иван Иванович"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1234567890,
                "ET_ID": 130,
                "Приоритет": 2,
                "LOGIN_ID": 77,
                "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
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Просмотры документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.views.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "KEY_ID": 103163,
                "DOC_ID": 101,
                "Активен": 1,
                "Документ": 101,
                "ДатаДокумента": "2025-01-26 21:30:21",
                "Срок": null,
                "Исполнен": null,
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "проект1954450",
                "Содержание": "Содержание документа",
                "Пользователь": "Сидоров С.С.",
                "Дата": "2025-01-26 21:30:21",
                "Активно": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные проекты документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "PARENTS = 'A'",
    "orderby": "PARENTS ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.projects.directory.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — P_ID integer (10) ID проекта
— — PARENTS string (255) Строка ID объектов родителей экранированных # (последний код всегда равен ID проекта)
— — Название string (255) Название проекта документа

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

{
    "request_identifier": "alphapi.docs.projects.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "P_ID": 103,
                "PARENTS": "#103#",
                "Название": "проект1954450"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные отчеты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) Да - ID типа документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.reports.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "F_ID": 1,
                "Название": "Название основного файла шаблона",
                "По умолчанию": 1
            },
            {
                "F_ID": 2,
                "Название": "Название другого файла шаблона",
                "По умолчанию": 0
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступ к документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Наследуемый.1010748.1019264",
                "ACCESS_ID": 1077,
                "DOC_ID": 1010748,
                "PROVIDER_TABLE_ID": 49,
                "PROVIDER_ID": 103,
                "RECIPIENT_TABLE_ID": 2,
                "RECIPIENT_ID": 1,
                "Тип": "Наследуемый",
                "Источник": "Группы пользователей",
                "Объект": "Администраторы",
                "Примечание": "Встроенная группа",
                "Родитель": "Проект: Договора и ДС"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Дерево комментариев
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.comments.parents.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "DOC_ID": 10,
                "RPT_ID": 3,
                "Номер": 101,
                "PARENTS": "#101#",
                "Название": "тест",
                "Заголовок": "Заголовок",
                "Дата": "2001-01-01 01:01:01",
                "GF": "#56.1036#"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Резолюции по документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "CHILD_ID": 10,
                "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,
                "LOGIN_ID": 102
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.clients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 101,
                "DOC_ID": 101,
                "CLIENT_ID": 101,
                "Ссылка": "По умолчанию",
                "Номер": 101,
                "Тип": "Юридическое лицо",
                "Название": "АЛЬФА ДОК",
                "Менеджер": "яяРазработчик",
                "Создана": "2001-01-01 01:01:01",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы подписей документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.files.signs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 101,
                "PARENT_ID": 101,
                "Активен": 1,
                "НомерДокумента": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название файла",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": "Примечание к файлу",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Атрибуты": "",
                "Размер": 12345
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Цвета файлов документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "F_ID = 'A'",
    "orderby": "F_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.files.colors.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — Цвет integer (10) Цвет

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

{
    "request_identifier": "alphapi.docs.files.colors.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "F_ID": 101,
                "DOC_ID": 101,
                "Цвет": 642815
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Хронология
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.chrono.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 101,
                "С": "2001-01-01 01:01:01",
                "ПО": "2002-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты
Города
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.city.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Город": "Москва"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Категории
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.categories.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Приоритет": "A"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать контрагента
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
client_id integer (10) Да - ID контрагента
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
type_id integer (10) Да - ID типа контрагента (1 - Клиент(Верхний уровень клиента), 2 - Подразделение(Обычно используется для объединения клиентов в различные группы), 3 - Юридическое лицо(Магазины и т.д.), 4 - ИП Индивидуальный предприниматель, 5 - Соб. юр. лицо, 6 - Частное лицо)
manager_id integer (10) Да - ID менеджера
region_id integer (10) Да - ID региона
segment_id integer (10) Да - ID сегмента
category string (1) Да - Категория контрагента, может принимать следующие значения: A,B,C
name string (255) Да - Наименование контрагента
discount float (255) - Размер скидки
comment string (255) - Комментарий контрагента
inn string (50) - ИНН юридического лица
kpp string (50) - КПП юридического лица
okato string (50) - ОКАТО юридического лица
okpo string (50) - ОКПО юридического лица
position string (255) - Должность
document string (255) - Документ, удостоверяющий личность контрагента
ogrn string (50) - ОГРН юридического лица
lf_id integer (10) - ID правовой формы юридического лица
city string (255) - Город контрагента
code string (255) - Внешний код контрагента

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

{
    "token": "unique_token_for_30_minutes",
    "client_id": 5,
    "parents": "#101##102#",
    "type_id": 3,
    "manager_id": 112,
    "region_id": 1931,
    "segment_id": 24,
    "category": "A",
    "name": "Петров А.А.",
    "discount": 10.5,
    "comment": "комментарий",
    "inn": "4363435434",
    "kpp": "56785658853",
    "okato": "2343243856780",
    "okpo": "7890754342",
    "position": "Директор",
    "document": "паспорт",
    "ogrn": "4578989045",
    "lf_id": 1,
    "city": "Москва",
    "code": "к484833"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.client.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— client_id integer (10) ID контрагента

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

{
    "request_identifier": "alphapi.client.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client edited successfully",
    "data": {
        "client_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить ID менеджера контрагента
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
client_id integer (10) Да - ID контрагента

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

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

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

{
    "request_identifier": "alphapi.client.manager.id.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Manager ID is 1054",
    "data": {
        "items": {
            "manager_id": 1054
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить доступ к контрагенту
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
client_id integer (10) Да - ID контрагента
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.client.access.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client access added successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить доступ к контрагенту
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
client_id integer (10) Да - ID контрагента
recipient_table_id integer (3) Да - ID таблицы получателя доступа
recipient_id integer (10) Да - ID получателя доступа

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

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

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

{
    "request_identifier": "alphapi.client.access.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client access deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.client.types.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TYPE_ID": 1,
                "Название": "Первый тип",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить контрагента
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
type_id integer (10) Да - ID типа контрагента (1 - Клиент(Верхний уровень клиента), 2 - Подразделение(Обычно используется для объединения клиентов в различные группы), 3 - Юридическое лицо(Магазины и т.д.), 4 - ИП Индивидуальный предприниматель, 5 - Соб. юр. лицо, 6 - Частное лицо)
manager_id integer (10) Да - ID менеджера
region_id integer (10) Да - ID региона
segment_id integer (10) Да - ID сегмента
category string (1) C Приоритет контрагента, может принимать следующие значения: A,B,C
name string (255) Да - Наименование контрагента
discount float (255) - Размер скидки
comment string (255) - Комментарий контрагента
inn string (50) - ИНН юридического лица
kpp string (50) - КПП юридического лица
okato string (50) - ОКАТО юридического лица
okpo string (50) - ОКПО юридического лица
position string (255) - Должность
document string (255) - Документ, удостоверяющий личность контрагента
ogrn string (50) - ОГРН юридического лица
lf_id integer (10) - ID правовой формы юридического лица
city string (255) - Город контрагента
code string (255) - Внешний код контрагента

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "type_id": 3,
    "manager_id": 112,
    "region_id": 1931,
    "segment_id": 24,
    "category": "A",
    "name": "Петров А.А.",
    "discount": 10.5,
    "comment": "комментарий",
    "inn": "4363435434",
    "kpp": "56785658853",
    "okato": "2343243856780",
    "okpo": "7890754342",
    "position": "Директор",
    "document": "паспорт",
    "ogrn": "4578989045",
    "lf_id": 1,
    "city": "Москва",
    "code": "к484833"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.client.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— client_id integer (10) ID контрагента

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

{
    "request_identifier": "alphapi.client.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client added successfully",
    "data": {
        "client_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить наличие контрагента
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
query string (255) Да - Поисковая фраза
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.client.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CLIENT_ID": 5,
                "Название": "ООО АльфаДок",
                "ИсходноеНазвание": "ООО АльфаДок",
                "Доступен": 1,
                "Найдено": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Информация об ИП
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.persons.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CLIENT_ID": 1020,
                "PERSON_ID": 102,
                "ДУЛ": "77 123456",
                "Должность": "Директор",
                "Примечания": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит справочников контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "AUDIT_ID = 'A'",
    "orderby": "AUDIT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.directories.audit.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — AUDIT_ID integer (17) ID записи аудита
— — Раздел string (50) Раздел
— — Объект string (255) Объект
— — Дата время datetime (Y-m-d H:i:s) Дата и время события
— — Параметр01 string (305) Предыдущее значение параметра или прочая информация
— — Параметр02 string (305) Следующее значение параметра или прочая информация
— — Станция string (255) Название компьютера, с которого произошло изменение
— — Пользователь string (564) Логин пользователя, который сделал изменение
— — Приоритет события integer (10) Приоритет события аудита
— — Событие string (255) Описание события аудита

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

{
    "request_identifier": "alphapi.clients.directories.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1883,
                "Раздел": "Организационно-правовые формы",
                "Объект": "ООО92510019",
                "Дата время": "2022-06-03 12:29:05",
                "Параметр01": "value1",
                "Параметр02": "value2",
                "Станция": "irisDB01",
                "Пользователь": "user01",
                "Приоритет события": 5,
                "Событие": "Изменение ОГРН юридического лица"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Справочники контрагентов. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.directories.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ObjID": 101,
                "CLIENT_ID": 5,
                "Раздел": "Должности",
                "Объект": "Бухгалтер",
                "Дата": "2001-01-01 01:01:01",
                "Индекс": "индекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Аудит контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1883,
                "CLIENT_ID": 107,
                "Дата время": "2022-06-03 12:29:05",
                "Параметр01": "value1",
                "Параметр02": "value2",
                "Станция": "irisDB01",
                "Пользователь": "user01",
                "Номер": 107,
                "Тип": "Соб. юр. лицо",
                "Название": "234524524",
                "Приоритет события": 5,
                "Событие": "Изменение ОГРН юридического лица"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты. Родители
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "CLIENT_ID = 'A'",
    "orderby": "CLIENT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.parents.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (10) ID таблицы
— — CLIENT_ID integer (10) ID контрагента
— — PARENTS string (50) Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
— — Название string (255) Название
— — Расширенное название string (308) Расширенное название

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

{
    "request_identifier": "alphapi.clients.parents.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "CLIENT_ID": 5,
                "PARENTS": "#101##105#",
                "Название": "Аптонекс",
                "Расширенное название": "ООО Аптонекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "CLIENT_ID": 101,
                "PARENTS": "#101#",
                "TYPE_ID": 4,
                "Номер": 101,
                "Тип": "Простой",
                "Название": "ООО Аптон",
                "Краткое название": "Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Скидка": 10.4,
                "Менеджер": "Иванов А.А.",
                "Примечание": "примечание",
                "Создан": "2021-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты без справочников
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "КПП = 'A'",
    "orderby": "КПП ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.int.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — CLIENT_ID integer (10) ID контрагента
— — PARENTS string (50) Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
— — Приоритет string (255) Приоритет контрагента
— — Название string (255) Название контрагента
— — Скидка float (255) Скидка контрагента
— — Примечание string (255) Примечание контрагента
— — КПП string (50) КПП контрагента
— — ОКАТО string (50) ОКАТО контрагента
— — ОКПО string (50) ОКПО контрагента
— — ДУЛ string (255) Документ, удостоверяющий личность контрагента
— — ИНН string (50) ИНН контрагента
— — ОГРН string (50) ОГРН контрагента
— — LF_ID integer (10) ID правовой формы юридического лица
— — Должность string (255) Должность контрагента
— — TYPE_ID integer (10) ID типа контрагента
— — MANAGER_ID integer (10) ID менеджера
— — SEGMENT_ID integer (10) ID сегмента
— — REGION_ID integer (10) ID региона
— — Город string (255) Город контрагента
— — Код string (255) Код контрагента

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

{
    "request_identifier": "alphapi.clients.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CLIENT_ID": 55,
                "PARENTS": "#101#",
                "Приоритет": "низкий",
                "Название": "ООО Сибирь",
                "Скидка": 0.5,
                "Примечание": "примечание",
                "КПП": "2343443455",
                "ОКАТО": "3456345354",
                "ОКПО": "9698494843",
                "ДУЛ": "Паспорт",
                "ИНН": "98796966976",
                "ОГРН": "3454343453",
                "LF_ID": 1,
                "Должность": "Директор",
                "TYPE_ID": 4,
                "MANAGER_ID": 8,
                "SEGMENT_ID": 3,
                "REGION_ID": 5,
                "Город": "Москва",
                "Код": "у3443"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступ к контрагентам (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.access.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CLIENT_ID": 5,
                "Номер": 5,
                "Тип контрагента": "Контрагент",
                "Название": "тест",
                "Регион": "Первый",
                "Сегмент": "Основной",
                "Приоритет": "C",
                "Менеджер": "user",
                "CustomKey": "Назначенный.101.1.102",
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Разработчик",
                "Пользователь": "Разработчик",
                "Родитель": "тест",
                "Примечание": "примечание"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступ к контрагентам
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Назначенный.101.1.102",
                "PROVIDER_TABLE_ID": 6,
                "PROVIDER_ID": 101,
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 102,
                "TABLE_ID": 6,
                "CLIENT_ID": 101,
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Разработчик",
                "Родитель": "test296764",
                "Примечание": "Представитель разработчика"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Комментарии контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
client_id integer 10 ID контрагента

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

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

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

{
    "request_identifier": "alphapi.clients.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 6,
                "COMMENT_ID": 143,
                "CLIENT_ID": 550,
                "Номер": 550,
                "Тип": "ООО",
                "Название": "ООО База",
                "Регион": "Москва",
                "Сегмент": "Лекарства",
                "Приоритет": "А",
                "Менеджер": "Петров П.П.",
                "Дата время": "2001-01-01 01:01:01",
                "Комментарий": "текст комментария",
                "Пользователь": "Сидоров П.С."
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контакты контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Номер = 'A'",
    "orderby": "Номер ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.contacts.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (5) ID таблицы
— — CONTACT_ID integer (10) ID контакта
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — CLIENT_ID integer (10) ID контрагента
— — Номер integer (10) Номер контрагента, равен его ID
— — Тип контрагента string (50) Тип контрагента
— — ПФ string (50) Правовая форма контрагента
— — Название string (255) Название контрагента
— — Регион string (255) Регион контрагента
— — Сегмент string (255) Сегмент контрагента
— — Приоритет string (255) Приоритет контрагента
— — Менеджер string (255) Менеджер контрагента
— — ФИО string (255) ФИО контрагента
— — Должность string (255) Должность контрагента
— — ДР date (Y-m-d) Дата рождения контрагента
— — Тип string (255) Тип контакта
— — Контакт string (255) Контакт
— — Примечание string (255) Примечание контакта
— — Создан datetime (Y-m-d H:i:s) Дата создания контакта
— — Контакт_MASK string (480) Маска поля ввода "Контакт" (используется для форматированного ввода текста в поле контакт)
— — Контакт_MASK_COND string (480) Содержит информацию об условии, которое нужно применить при поиске контактов данного типа

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

{
    "request_identifier": "alphapi.clients.contacts.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "CONTACT_ID": 101,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "CLIENT_ID": 34,
                "Номер": 444,
                "Тип контрагента": "Простой",
                "ПФ": "ООО",
                "Название": "ООО Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов А.А.",
                "ФИО": "Петров Александр Иванович",
                "Должность": "Директор",
                "ДР": "",
                "Тип": "Поставщик",
                "Контакт": "тел. 83504332, почта top@sales.com",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01",
                "Контакт_MASK": "",
                "Контакт_MASK_COND": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Адреса контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.address.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ADDRESS_ID": 101,
                "CLIENT_ID": 34,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "Номер": 444,
                "Тип контрагента": "Простой",
                "Название": "ООО Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов А.А.",
                "Тип": "Поставщик",
                "Адрес": "тел. 83504332, почта top@sales.com",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01",
                "Адрес_MASK": "",
                "Адрес_MASK_COND": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Справочники контрагентов. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "CLIENT_ID": 5,
                "Раздел": "Должности",
                "Объект": "Бухгалтер",
                "Дата": "2001-01-01 01:01:01",
                "Индекс": "индекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "CLIENT_ID": 101,
                "PARENTS": "#101#",
                "TYPE_ID": 4,
                "Штрих": "44543",
                "Родитель": "ООО УБС",
                "Номер": 101,
                "Тип": "Простой",
                "Название": "ООО Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Скидка": 10.4,
                "Менеджер": "Иванов А.А.",
                "Город": "Вологда",
                "Примечание": "примечание",
                "ПФ": "ООО",
                "ИНН": "345254454",
                "ОГРН": "345654445466",
                "КПП": "3678254454111",
                "ОКАТО": "39994454453",
                "ОКПО": "4323554556",
                "Должность": "Директор",
                "ДУЛ": "Паспорт",
                "Создан": "2021-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты документов
URL:
Эмулятор
Документы контрагентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.docs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 1,
                "DOC_ID": 101,
                "CLIENT_ID": 234,
                "Ссылка": "Ссылка",
                "Активен": 1,
                "Тип": "Тип",
                "Номер": 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"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы клиентов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 28,
                "F_ID": 101,
                "PARENT_TABLE_ID": 6,
                "PARENT_ID": 101,
                "Название": "Название_файла.docx",
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": null,
                "Создан": "2001-01-01 01:01:01",
                "Пользователь": "Сидоров С.С."
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Контрагенты. Дерево
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.clients.tree.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "CLIENT_ID": 5,
                "PARENTS": "#101##105#",
                "Название": "Аптонекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Банковские счета
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "ACCOUNT_ID = 'A'",
    "orderby": "ACCOUNT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.accounts.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — ACCOUNT_ID integer (10) ID реквизитов
— — CLIENT_ID integer (10) ID контрагента
— — Номер integer (10) Номер контрагента, равен его ID
— — Тип контрагента string (50) Тип контрагента
— — Название string (255) Название контрагента
— — Регион string (255) Регион контрагента
— — Сегмент string (255) Сегмент контрагента
— — Приоритет string (255) Приоритет контрагента
— — Менеджер string (255) Менеджер контрагента
— — Банк string (255) Наименование банка
— — БИК string (9) БИК
— — КС string (20) Корреспондентский счет
— — РС string (20) Расчетный счет
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.clients.accounts.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ACCOUNT_ID": 2,
                "CLIENT_ID": 4,
                "Номер": 4,
                "Тип контрагента": "простой",
                "Название": "ООО Фарма",
                "Регион": "Москва",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов Иван Иванович",
                "Банк": "Сбербанк",
                "БИК": "293474454",
                "КС": "40084545549348834335",
                "РС": "40084545549000004335",
                "Примечание": "Текст"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Банки ЦБ РФ
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
search_query_bank_name string - Название банка
search_query_bik string - БИК банка

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

{
    "token": "unique_token_for_30_minutes",
    "search_query_bank_name": "Сбер",
    "search_query_bik": "35783"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.external.sbrf.banks.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — bank_name string (255) Название банка
— — bik string (9) БИК
— — kc string (20) Кор. счет

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

{
    "request_identifier": "alphapi.external.sbrf.banks.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "bank_name": "Сбербанк",
                "bik": "123456789",
                "kc": "12345678901234567890"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
140 Метод "%s" не поддерживает параметры: %s
401 Токен неизвестен, либо его срок действия истек.
1000 Файл не доступен на удаленном хранилище
1001 Ошибка обработки файла. Шаг %s
Данные юридического лица или ИП из ФНС
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
inn integer (12) Да - ИНН юридического лица или ИП

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

{
    "token": "unique_token_for_30_minutes",
    "inn": 7707083893
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.external.fns.legalentity.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные юридического лица или ИП
— inn string (12) ИНН
— ogrn string (15) ОГРН или ОГРНИП
— kpp string (9) КПП (для ИП пустая строка)
— short_name string (255) Краткое наименование или ФИО ИП
— full_name string (1024) Полное наименование или ФИО ИП
— address string (2048) Полный адрес

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

{
    "request_identifier": "alphapi.external.fns.legalentity.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "inn": "7707083893",
        "ogrn": "1027700132195",
        "kpp": "773601001",
        "short_name": "ПАО СБЕРБАНК",
        "full_name": "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО «СБЕРБАНК РОССИИ»",
        "address": "117312, г. Москва, ул. Вавилова, д. 19"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Ошибка. Получен пустой ответ от API ФНС
1002 Ошибка. Получен неверный тип данных от API ФНС
1003 Ответ API ФНС. (%s)
Редактировать сегмент
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
segment_id integer (10) Да - ID сегмента
segment_name string (255) Да - Название сегмента
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.segments.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Segment edited successfully",
    "data": {
        "segment_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить сегмент
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
segment_name string (255) Да - Название сегмента
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.segments.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Segment added successfully",
    "data": {
        "segment_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Сегменты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.segments.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "SEGMENT_ID": 1,
                "Название": "Администрация",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить сегмент
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
segment_id integer (10) Да - ID сегмента

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

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

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

{
    "request_identifier": "alphapi.segments.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Segment deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество контрагентов текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.my.clients.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My clients count is 2",
    "data": {
        "items": {
            "my_clients_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать регион
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
region_id integer (10) Да - ID региона
region_name string (255) Да - Название региона
region_center string (255) - Центр региона
tz_id integer (1) Да - ID часового пояса
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.regions.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Region edited successfully",
    "data": {
        "region_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить регион
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
region_name string (255) Да - Название
region_center string (255) - Центр
tz_id integer (1) Да - ID Часового пояса
comment string (255) - Примечание

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

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

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

{
    "request_identifier": "alphapi.regions.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Region added successfully",
    "data": {
        "region_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Регионы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.regions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "REGION_ID": 1,
                "TZ_ID": 5,
                "Название": "Основной",
                "НазваниеПолное": "Основной (МСК-00:00:00)",
                "Центр": "Москва",
                "Часовой пояс": "(GMT+03:00:00) Москва, Санкт-Петербург, Волгоград, Баку, Ереван",
                "Примечание": "Центральный регион"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить регион
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
region_id integer (10) Да - ID региона

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

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

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

{
    "request_identifier": "alphapi.regions.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Region deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Менеджеры
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.managers.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "Логин": "alpha-101",
                "ФИО": "Иванов Иван Иванович",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Основная группа": "Основная группа",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Маршрут
Реестр точек маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.routepoints.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 101990,
                "RPS_ID": 1,
                "PARENTS": "#101990#",
                "DOC_ID": 101002,
                "Номер": 5,
                "Описание": "контент 759846",
                "Исполнитель": "Менеджеры \/Разработчик\/",
                "ФИО": "Разработчик",
                "Срок": "2022-03-30 13:20:31",
                "Дата": "2022-03-25 13:12:27"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить контролёра точки маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parents string (255) Да - Строка ID объектов родителей, экранированных # (последний код всегда равен ID точки маршрута)
doc_controller string (255) Да - Контролёр документа

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#104#",
    "doc_controller": "Разработчик"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.routepoints.controller.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— routepoint_controller string (255) Контролёр точки маршрута

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

{
    "request_identifier": "alphapi.routepoints.controller.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Routepoint controller is Разработчик",
    "data": {
        "items": {
            "routepoint_controller": "Разработчик"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Стандартные маршруты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Проект = 'A'",
    "orderby": "Проект ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.standard.routes.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DOC_ID integer (10) ID документа
— — Проект string (255) Проект
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Содержание string (255) Содержание документа
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Комментарий string (255) Комментарий документа

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

{
    "request_identifier": "alphapi.standard.routes.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DOC_ID": 1012,
                "Проект": "Договора",
                "Номер": 1012,
                "Содержание": "Содержание документа",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Комментарий": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить наличие маршрута у завершенного документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.is.route.empty",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is false",
    "data": {
        "items": {
            "result": false
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить дату старта точки маршрута (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута
prev integer[] Да - Массив точек маршрута, от которых зависит точка маршрута
doc_id integer (10) Да - ID документа

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 104,
    "prev": [
        1
    ],
    "doc_id": 102
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.startdateex.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— start_date_ex datetime (Y-m-d H:i:s) Дата старта точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.startdateex.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Routepoint start date is 2022-03-24 00:00:00",
    "data": {
        "items": {
            "start_date_ex": "2022-03-24 00:00:00"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить ID пользователя исполнителя точки маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.responsibles.id.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Responsible ID is 102",
    "data": {
        "items": {
            "responsible_id": 102
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
404 Не найдено
Получить дату старта точки маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
rp_id integer (10) Да - ID точки маршрута

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 104
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc-routepoint.startdate.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— start_date datetime (Y-m-d H:i:s) Дата старта точки маршрута

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

{
    "request_identifier": "alphapi.doc-routepoint.startdate.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Routepoint start date is 2022-03-24 00:00:00",
    "data": {
        "items": {
            "start_date": "2022-03-24 00:00:00"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить наличие неуказанных исполнителей в маршруте документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.stroute.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is 0",
    "data": {
        "items": {
            "result": 0
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Точки маршрута документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "Статус = 'A'",
    "orderby": "Статус ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.routepoints.directory.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — RP_ID integer (10) ID точки маршрута
— — RPT_ID integer (10) ID типа точки маршрута (1 - Поручение, 2 - Согласование, 3 - Уведомление)
— — RPS_ID integer (10) ID статуса точки маршрута
— — PARENTS string (255) Строка ID родителей экранированных # (последний код всегда равен ID поручения)
— — LINKS string (255) Строка ID входящих зависимостей, экранированных #
— — DOC_ID integer (10) ID документа
— — PARENT_ID integer (10) ID сущности
— — Номер integer (3) Последовательный номер точки маршрута по последовательности исполнения документа
— — Описание string (255) Описание точки маршрута
— — Исполнитель string (255) Исполнитель точки маршрута
— — Срок datetime (Y-m-d H:i:s) Срок точки маршрута
— — Дата datetime (Y-m-d H:i:s) Дата точки маршрута

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

{
    "request_identifier": "alphapi.docs.routepoints.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "RPT_ID": 1,
                "RPS_ID": 3,
                "PARENTS": "#101#",
                "LINKS": null,
                "DOC_ID": 101,
                "PARENT_ID": null,
                "Номер": 0,
                "Описание": "Добавлен комментарий",
                "Исполнитель": "Имя",
                "Срок": "2001-01-01 01:01:01",
                "Дата": "2001-01-01 01:01:01"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Поручения по документу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer Да - ID документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.docs.routepoints.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 101,
                "LOGIN_ID": 101,
                "RPT_ID": 2,
                "RPS_ID": 3,
                "PARENTS": "#101#",
                "LINKS": null,
                "Уровень": 0,
                "Номер": 0,
                "Предыдущий": "",
                "Тип": "Уведомление",
                "Срок": "2001-01-01 01:01:01",
                "Дней": 3,
                "Выполнено": "",
                "Исполнитель": "Имя",
                "Контролер": "Имя",
                "Статус": "Просрочено",
                "Описание": "Добавлен комментарий",
                "Примечание": "Добавлен комментарий",
                "Индикатор": -9,
                "Создана": "2001-01-01 01:01:01",
                "Флаг": 1,
                "Родитель": 101
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Точки маршрута
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer (10) Да - ID документа

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.gantt.items.directory.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы точек маршрута
— — RP_ID integer (10) ID точки маршрута
— — DOC_ID integer (10) ID документа
— — RPT_ID integer (10) ID типа точки маршрута (1 - Поручение, 2 - Согласование, 3 - Уведомление)
— — RPS_ID integer (10) ID статуса точки маршрута
— — DOC_CONTROLLER_ID integer (10) ID пользователя контролера документа
— — LOGIN_ID integer (10) ID пользователя исполнителя по точке маршрута
— — LINKS string (255) Строка вида #ID1##ID2# связей точки маршрута
— — PARENTS string (255) Строка вида #ID1##ID2#, которая указывает на родительскую точку маршрута
— — PARENT_ID integer (10) ID сущности
— — Номер integer (10) Номер точки маршрута в документе, отсортировано автоматически
— — Статус string (50) Статус точки маршрута
— — Документ string (771) Описание документа точки маршрута
— — Описание string (408) Описание точки маршрута
— — Исполнитель string (755) Исполнитель данной точки маршрута (должность/группа/пользователь)
— — Контролер string (255) Контролер точки маршрута (может отличаться от контролера документа)
— — ПолеПоиска string (1975) Поле поиска
— — Примечание string (255) Примечание точки маршрута
— — Expr1 integer (10) Expr1

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

{
    "request_identifier": "alphapi.docs.gantt.items.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 1,
                "RPS_ID": 1,
                "DOC_CONTROLLER_ID": 101,
                "LOGIN_ID": 101,
                "LINKS": "#101##102#",
                "PARENTS": "#101##102#",
                "PARENT_ID": 101,
                "Номер": 101,
                "Статус": "Ожидает",
                "Документ": "Описание документа точки маршрута",
                "Описание": "Описание точки маршрута",
                "Исполнитель": "Должность\/группа\/пользователь",
                "Контролер": "Иванов И.И.",
                "ПолеПоиска": "Поле поиска",
                "Примечание": null,
                "Expr1": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Начальный маршрут документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.docs.gantt.items.initial.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 1,
                "RPS_ID": 1,
                "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
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Маршрут документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer (10) Да - ID документа

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

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

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

{
    "request_identifier": "alphapi.docs.gantt.items.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 1,
                "RPS_ID": 1,
                "DOC_CONTROLLER_ID": 101,
                "LOGIN_ID": 101,
                "LINKS": "#101##102#",
                "PARENTS": "#101##102#",
                "PARENT_ID": 101,
                "Номер": 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
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Неуказанные исполнители
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк
doc_id integer Да - ID документа
substitutions Параметры подстановки
— DT_ID integer (10) - ID типа документа
— Содержание string (255) - Содержание
— Срок date (Y-m-d) - Срок
— Проект string (255) - Проект
— Рег.номер string (50) - Регистрационный номер документа
— Дата date (Y-m-d) - Дата
— MASK string (255) - Маска
— MASK_PARAM1 string (255) - Параметр маски 1
— MASK_PARAM2 string (255) - Параметр маски 2

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "Дней = 5",
    "orderby": "Сортировка ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.routes.responsibles.unspecified.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — RESPONSIBLE_TABLE_ID integer (3) ID таблицы сущности исполнителя (пользователь/должность/группа)
— — RESPONSIBLE_ID integer (10) ID сущности исполнителя (пользователь/должность/группа)
— — RPT_ID integer (10) ID типа точки маршрута (1 - Поручение, 2 - Согласование, 3 - Уведомление)
— — Срок datetime (Y-m-d H:i:s) Срок точки маршрута
— — Дней integer (3) Срок точки маршрута в рабочих днях, если он был указан при создании маршрута
— — Описание string (100) Описание точки маршрута
— — Примечание string (255) Примечание точки маршрута
— — Срок документа integer (1) Срок документа
— — Редактируемый срок integer (1) Редактируемый срок
— — Редактируемое описание integer (1) Редактируемое описание

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

{
    "request_identifier": "alphapi.routes.responsibles.unspecified.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 101,
                "RPT_ID": 1,
                "Срок": "2001-01-01 01:01:01",
                "Дней": 3,
                "Описание": "Добавлен комментарий",
                "Примечание": "Добавлен комментарий",
                "Срок документа": 1,
                "Редактируемый срок": 0,
                "Редактируемое описание": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип документа с ID "%s" не найден
1002 Параметры документа не переданы
Шаблоны файлов в маршрутах
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_ids integer[] Да - Массив идентификаторов документов
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "doc_ids": [
        101,
        102,
        103
    ],
    "where": "Название маршрута = 'A'",
    "orderby": "Название маршрута ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.routes.files.templates.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — Название маршрута string (255) Название маршрута
— — Название шаблона string (59) Название шаблона
— — Редакция integer (10) Редакция
— — Создан datetime (Y-m-d H:i:s) Дата создания
— — Размер integer (10) Размер
— — Автор string (255) Автор
— — Файл string (255) Файл
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.routes.files.templates.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "F_ID": 12,
                "DOC_ID": 345,
                "Название маршрута": "Машрут 1",
                "Название шаблона": "Шаблон 1",
                "Редакция": 5,
                "Создан": "2022-03-24 12:57:04",
                "Размер": 7,
                "Автор": "Пользователь05",
                "Файл": "test.pdf",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Недавние маршруты документов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dt_id integer (10) - ID типа документа
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 1,
    "where": "Тип = 'A'",
    "orderby": "Тип ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.recent.docs.routes.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (10) ID таблицы
— — DT_ID integer (10) ID типа документа
— — DOC_ID integer (10) ID документа
— — Тип string (50) Тип документа
— — Содержание string (255) Содержание документа
— — Содержание_MASK string (480) Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание

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

{
    "request_identifier": "alphapi.recent.docs.routes.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 3,
                "DT_ID": 101,
                "DOC_ID": 101,
                "Тип": "Уведомление",
                "Содержание": "Содержание документа",
                "Содержание_MASK": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Диаграмма Ганта
Доступные действия элемента Ганта
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
doc_id integer (10) Да - ID документа. Обязателен; положительное целое число
rp_id integer (10) Да - ID точки маршрута. Обязателен; положительное целое число
rpt_id integer (10) - RPT_ID: тип точки (1 — поручение, 2 — согласование, 3 — уведомление)
rps_id integer (10) - RPS_ID: статус точки (1–9)
login_id integer (10) - LOGIN_ID: ID пользователя исполнителя точки, не ID группы/должности
responsible_table_id integer (10) - RESPONSIBLE_TABLE_ID: таблица исполнителя (группа — 2)
parents string (255) - PARENTS: путь вида #101##103#, последний ID равен rp_id. #103# — корень
rp_parent_id integer (10) - Родитель: ID точки — источника копирования, не родитель по иерархии. NULL допустим
controller_id integer (10) - CONTROLLER_ID: ID пользователя контролёра документа. При пропуске загружается из DOCS_INT по doc_id
dt_id integer (10) - DT_ID: тип документа; 2 — стандартный маршрут. При пропуске загружается из DOCS_INT по doc_id
doc_finished boolean - Признак исполнения документа: true — исполнен, false — не исполнен. При пропуске определяется по полю Исполнен (не NULL) из DOCS_INT по doc_id. NULL недопустим
parent_responsible_login_id integer (10) - ID пользователя исполнителя непосредственного родителя. NULL/-1 — отсутствует. При пропуске загружается только для вложенной точки; у корня игнорируется

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 501,
    "rp_id": 103,
    "rpt_id": 1,
    "rps_id": 2,
    "login_id": 101,
    "responsible_table_id": 1,
    "parents": "#103#",
    "rp_parent_id": null,
    "controller_id": 200,
    "dt_id": 1,
    "doc_finished": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.gantt.item.available.actions.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— items Результат для выбранной точки
— — RP_ID integer (10) ID точки маршрута
— — DOC_ID integer (10) ID документа
— — ACTIONS Фиксированные 27 действий, включая скрытые
— — — copy Копирование (всегда скрыто, ENABLED = NULL)
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — insert_standard_route Вставить стандартный маршрут
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — insert_standard_route_with_comment Вставить стандартный маршрут с комментарием
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — insert_route_from_document Вставить маршрут из документа
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_task_after Создать поручение после
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_notification_after Создать уведомление после
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_agreement_after Создать согласование после
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — insert_standard_route_after Вставить стандартный маршрут после
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — insert_route_from_document_after Вставить маршрут из документа после
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — replicate_users_and_groups Тиражировать по пользователям и группам
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — replicate Тиражировать точку
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_stopped Остановить
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — recreate_full_route Пересоздать маршрут полностью (ENABLED = VISIBLE)
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — recreate_partial_route Пересоздать маршрут частично (ENABLED = VISIBLE)
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_finished Отметить завершённым
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_taken Взять в работу
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_linked_document Создать связанный документ
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — add_comment Добавить комментарий
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_sub_task Создать подпоручение
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_sub_notification Создать подуведомление
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — create_sub_agreement Создать подсогласование
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_confirmed_finish Подтвердить завершение
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_returned Вернуть
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_accepted Одобрить
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_declined Отклонить
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — mark_viewed Отметить просмотренным
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy
— — — edit Редактировать точку: контролёр документа или исполнитель непосредственного родителя; для стандартного маршрута — только контролёр документа. Недоступно для исполненного документа
— — — — VISIBLE boolean Показывать действие
— — — — ENABLED boolean Действие доступно; NULL только для copy

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

{
    "request_identifier": "alphapi.gantt.item.available.actions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Available actions calculated.",
    "data": {
        "items": {
            "RP_ID": 103,
            "DOC_ID": 501,
            "ACTIONS": {
                "copy": {
                    "VISIBLE": false,
                    "ENABLED": null
                },
                "insert_standard_route": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "insert_standard_route_with_comment": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "insert_route_from_document": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "create_task_after": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "create_notification_after": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "create_agreement_after": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "insert_standard_route_after": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "insert_route_from_document_after": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "replicate_users_and_groups": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "replicate": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_stopped": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "recreate_full_route": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "recreate_partial_route": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_finished": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "mark_taken": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "create_linked_document": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "add_comment": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "create_sub_task": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "create_sub_notification": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "create_sub_agreement": {
                    "VISIBLE": true,
                    "ENABLED": true
                },
                "mark_confirmed_finish": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_returned": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_accepted": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_declined": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "mark_viewed": {
                    "VISIBLE": false,
                    "ENABLED": false
                },
                "edit": {
                    "VISIBLE": false,
                    "ENABLED": false
                }
            }
        }
    }
}
Описание
Расчёт меню точки маршрута в онлайн-режиме.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
150 Некорректное поле контекста точки маршрута: %s
151 Не удалось получить контекст точки маршрута: %s
401 Токен неизвестен, либо его срок действия истек.
404 Не найдено
Реестр элементов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "LINKS = 'A'",
    "orderby": "LINKS ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.gantt.items.directory.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — RP_ID integer (10) ID точки маршрута
— — DOC_ID integer (10) ID документа
— — RPT_ID integer (10) ID типа поручения (Поручение/Уведомление/Согласование)
— — RPS_ID integer (10) ID статуса поручения
— — DOC_CONTROLLER_ID integer (10) ID пользователя контролера документа
— — LOGIN_ID integer (10) ID пользователя исполнителя поручения
— — LINKS string (255) Строка ID входящих зависимостей экранированных #
— — PARENTS string (255) Строка ID объектов родителей экранированных # (последний код всегда равен ID точки маршрута)
— — Номер integer (10) Номер
— — Статус string (50) Статус точки маршрута
— — Документ string (916) Информация о документе
— — Описание string (667) Описание
— — Исполнитель string (755) Исполнитель (Должность/группа/пользователь)
— — Контролер string (255) Контролер точки маршрута
— — ПолеПоиска string (1975) Поле поиска

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

{
    "request_identifier": "alphapi.gantt.items.directory.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 102038,
                "DOC_ID": 101002,
                "RPT_ID": 2,
                "RPS_ID": 1,
                "DOC_CONTROLLER_ID": 102,
                "LOGIN_ID": 102,
                "LINKS": null,
                "PARENTS": "#102038#",
                "Номер": 5,
                "Описание": "5. Согласование: контент 127645",
                "Исполнитель": "Разработчик",
                "Документ": "№101002 текст, (Разработчик)",
                "Статус": "Ожидает",
                "Контролер": "Разработчик",
                "ПолеПоиска": "102текст1УведомлениетекстПринятоРазработчикРазработчик"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Элементы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.gantt.items.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 56,
                "RP_ID": 102038,
                "DOC_ID": 101002,
                "RPT_ID": 2,
                "RPS_ID": 1,
                "DOC_CONTROLLER_ID": 102,
                "LOGIN_ID": 102,
                "LINKS": null,
                "PARENTS": "#102038#",
                "Номер": 5,
                "Описание": "5. Согласование: контент 127645",
                "Исполнитель": "Разработчик",
                "Документ": "№101002 текст, (Разработчик)",
                "Статус": "Ожидает",
                "НачалоПлан": "2022-03-30 00:00:00",
                "Начало": "2022-03-30 00:00:00",
                "Срок": "2030-12-23 00:00:00",
                "Выполнено": null,
                "Подтверждено": null,
                "Индикатор": 1416,
                "Контролер": "Разработчик"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Системные
Количество объектов для репликации
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.repobjects.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Replication objects count is 2",
    "data": {
        "items": {
            "rep_objects_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать лицензию
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sn string (19) Да - SN
hw string (19) - HW
akey string (19) - AKey
comment string (255) - Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "sn": "B010-JF36-39E0-88BC",
    "hw": "4210-JFZZ-3BB0-897C",
    "akey": "BJ34-MMBZ-3YY0-8HQ5",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.licenses.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— sn varchar (19) SN

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

{
    "request_identifier": "alphapi.licenses.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "License edited successfully",
    "data": {
        "sn": "B010-JF36-39E0-88BC"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить название компании лицензиата
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

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

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

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

{
    "request_identifier": "alphapi.licenses.getcompanyname",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "company_name": "ООО Альфадок"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить лицензию
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sn string (19) Да - SN
hw string (19) - HW
akey string (19) - AKey
comment string (255) - Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "sn": "B010-JF36-39E0-88BC",
    "hw": "4210-JFZZ-3BB0-897C",
    "akey": "BJ34-MMBZ-3YY0-8HQ5",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.licenses.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— sn varchar (19) SN

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

{
    "request_identifier": "alphapi.licenses.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "License added successfully",
    "data": {
        "sn": "B010-JF36-39E0-88BC"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Лицензии (расширенный)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Тип = 'A'",
    "orderby": "Тип ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.licenses.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — Тип string (50) Тип лицензии
— — Номер string (19) SN
— — Запрос string (19) HW
— — Активация string (19) AKey
— — Примечание string (255) Примечание к лицензии

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

{
    "request_identifier": "alphapi.licenses.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "Лицензия на 1 АРМ",
                "Номер": "Of73vq0UBH53ibVH2Zy",
                "Запрос": "3k2XInoaAPJ7G63zxBW",
                "Активация": "L45fhCK2RUHDq6bfn4B",
                "Примечание": "коммент4692000"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Лицензии
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

{
    "token": "unique_token_for_30_minutes",
    "where": " = 'A'",
    "orderby": " ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.licenses.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — SN string (19) SN
— — HW string (19) HW
— — AKey string (19) AKey
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.licenses.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "SN": "B010-JF36-39E0-88BC",
                "HW": "4210-JFZZ-3BB0-897C",
                "AKey": "BJ34-MMBZ-3YY0-8HQ5",
                "Примечание": "комментарий"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить лицензию
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sn varchar (19) Да - SN

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

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

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

{
    "request_identifier": "alphapi.licenses.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "License deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Серверы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.servers.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 46,
                "SERVER_ID": 1,
                "SRVT_ID": 1,
                "Тип": 1,
                "Номер": 1,
                "Название": "Сервер",
                "Адрес": "storage.alpha-doc.ru:1234",
                "Путь": "\/dev\/",
                "Логин": "alphadoc_storage",
                "Пароль": "gsd}Ubdf13gd",
                "Примечание": null,
                "Активен": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активировать сервер
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
server_id integer (10) Да - ID сервера

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

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

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

{
    "request_identifier": "alphapi.server.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать сервер
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
SERVER_ID integer (10) - ID сервера
SRVT_ID integer (10) Да - ID типа сервера
Номер integer (3) - Порядковый номер
Название string (50) - Название сервера
Адрес string (50) - Адрес сервера
Путь string (50) - Дополнительная информация (папка для ftp, кодировка для email)
Логин string (50) - Логин для авторизации
Пароль string (50) - Пароль для авторизации
Примечание string (255) - Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "SERVER_ID": 111,
    "SRVT_ID": 1,
    "Номер": 1,
    "Название": "Сервер",
    "Адрес": "storage.alpha-doc.ru:1234",
    "Путь": "\/dev\/",
    "Логин": "alphadoc_storage",
    "Пароль": "gsd}Ubdf13gd",
    "Примечание": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.server.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.server.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Server edited successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать сервер
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
server_id integer (10) Да - ID сервера

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

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

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

{
    "request_identifier": "alphapi.server.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить сервер
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
SRVT_ID integer (10) - ID типа сервера
Номер integer (3) - Порядковый номер
Название string (50) - Название сервера
Адрес string (50) - Адрес сервера
Путь string (50) - Дополнительная информация (папка для ftp, кодировка для email)
Логин string (50) - Логин для авторизации
Пароль string (50) - Пароль для авторизации
Примечание string (255) - Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "SRVT_ID": 1,
    "Номер": 1,
    "Название": "Сервер",
    "Адрес": "storage.alpha-doc.ru:1234",
    "Путь": "\/dev\/",
    "Логин": "alphadoc_storage",
    "Пароль": "gsd}Ubdf13gd",
    "Примечание": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.server.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— SERVER_ID integer (10) ID сервера

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

{
    "request_identifier": "alphapi.server.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Server added successfully",
    "data": {
        "SERVER_ID": 111
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить сервер
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
server_id integer (10) Да - ID сервера

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

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

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

{
    "request_identifier": "alphapi.server.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Server deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить все GUI настройки у роли
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
role_id integer (10) Да - ID роли

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

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

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

{
    "request_identifier": "alphapi.gui.elements.role.delall",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "All GUI role settings deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Скопировать настройки GUI с роли на роль
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
role_id_child integer (10) Да - ID роли-получателя
role_id_parent integer (10) Да - ID роли-источника

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

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

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

{
    "request_identifier": "alphapi.gui.elements.role.copy",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "GUI elements copied from role successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить GUI элемент для роли
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
guie_id integer (10) Да - ID GUI элемента
role_id integer (10) Да - ID роли

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

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

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

{
    "request_identifier": "alphapi.gui.elements.role.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "GUI element added to role successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить GUI элемент у роли
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
guie_id integer (10) Да - ID GUI элемента
role_id integer (10) Да - ID роли

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

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

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

{
    "request_identifier": "alphapi.gui.elements.role.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "GUI element deleted from role successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные элементы интерфейса
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.gui.elements.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 6,
                "GUIE_ID": 22,
                "Описание": "Контрагенты. Редактирование",
                "Примечание": "Контрагенты"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Элементы GUI
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.gui.elements.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 5,
                "GUIE_ID": 11,
                "Описание": "Контрагенты. Редактирование",
                "Примечание": "примечание"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Разница в рабочих днях
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
date_start date (YYYY-MM-DD) Да - Стартовая дата для вычисления
date_end date (YYYY-MM-DD) Да - Конечная дата для вычисления

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

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

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

{
    "request_identifier": "alphapi.system.workdaysdiff",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count_days": 11
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Системный аудит
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

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

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

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

{
    "request_identifier": "alphapi.system.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 126780,
                "Раздел": "Пользователи",
                "Объект": "developer",
                "Дата время": "2024-09-17 16:40:24",
                "Параметр1": "Иванов ИИ13554050",
                "Параметр2": "Успешно, ID 1010",
                "Станция": "::1",
                "Пользователь": "developer-1 \/Разработчик\/",
                "Приоритет события": 5,
                "Событие": "Удаление представителя"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Пометить как непрочитанное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности

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

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

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

{
    "request_identifier": "alphapi.system.set.unread",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Пометить как непрочитанное (множественно)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (5) Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_ids integer[] (10) Да - Массив ID

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

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

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

{
    "request_identifier": "alphapi.system.set.massunread",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Пометить все объекты как прочитанные
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
table_id integer (3) Да - ID таблицы сущности (возможные значения 55, 56, 11)

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

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

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

{
    "request_identifier": "alphapi.system.set.read",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить пароль логина
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login varchar (1,255) Да - Логин пользователя
password varchar (6,32) Да - Новый пароль пользователя

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

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

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

{
    "request_identifier": "alphapi.system.logins.password.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Password set successfully"
}
Описание
ВАЖНО: Метод работает только для базы данных POSTGRESQL и требует для работы прямой связи с сервером (VPN или облачное размещение)
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Создать логин
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login varchar (1,255) Да - Логин пользователя
password varchar (6,32) Да - Пароль пользователя
roles varchar[] - Массив ролей. Допустимые значения: "Администратор","Главный менеджер","Делопроизводитель","Менеджер","Пользователь"

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

{
    "token": "unique_token_for_30_minutes",
    "login": "new_user_login",
    "password": "StrengthPasswordWithSpecialChars",
    "roles": [
        "Пользователь",
        "Главный менеджер"
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.logins.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.logins.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Login created successfully"
}
Описание
ВАЖНО: Метод работает только для базы данных POSTGRESQL и требует для работы прямой связи с сервером (VPN или облачное размещение)
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Логин "%s" создавать запрещено.
Назначить роли логину
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login varchar (1,255) Да - Логин пользователя
roles varchar[] Да - Массив ролей. Допустимые значения: "Администратор","Главный менеджер","Делопроизводитель","Менеджер","Пользователь"

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

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

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

{
    "request_identifier": "alphapi.system.logins.roles.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Roles assigned successfully"
}
Описание
ВАЖНО: Метод работает только для базы данных POSTGRESQL и требует для работы прямой связи с сервером (VPN или облачное размещение)
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
113 Некорректный строковый массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить роли у логина
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login varchar (1,255) Да - Логин пользователя
roles varchar[] Да - Массив ролей. Допустимые значения: "Администратор","Главный менеджер","Делопроизводитель","Менеджер","Пользователь"

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

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

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

{
    "request_identifier": "alphapi.system.logins.roles.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Roles removed successfully"
}
Описание
ВАЖНО: Метод работает только для базы данных POSTGRESQL и требует для работы прямой связи с сервером (VPN или облачное размещение)
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
113 Некорректный строковый массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удаление файлов сущности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности

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

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

Пример ответа:

{
    "request_identifier": "alphapi.system.entity.files.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Задержка в системе репликации
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.rplobjects.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count_rpl_objects integer (10) Время задержки репликации в минутах

Пример ответа:

{
    "request_identifier": "alphapi.system.rplobjects.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count_rpl_objects": 0
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Состояние системы репликации
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.rplobjects.check Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— check_rpl_objects integer (10) Оценка комбинаций серверов в репликации, если значение равно 0, то система репликации не настроена

Пример ответа:

{
    "request_identifier": "alphapi.system.rplobjects.check",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "check_rpl_objects": 0
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Отправить электронное письмо
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
subject string Письмо из системы Документооборота Тема письма
message text Отправлено из системы Документооборота Текст письма; поддерживаются HTML-теги p, br, b, strong, i, u, ul, ol, li
to Массив получателей письма
— email string - Адрес электронной почты получателя
— name string - Имя получателя
cc Массив получателей копии письма
— email string - Адрес электронной почты получателя
— name string - Имя получателя
attachments Массив вложений письма
— file_name string - Имя файла
— file_base64_content text - Содержимое файла в формате BASE64
reply_to_as_user_email boolean - Указать адрес текущего пользователя в Reply-To
from_as_user_email boolean - Использовать адрес текущего пользователя как адрес отправителя
set_user_fio_as_from_name boolean - Использовать ФИО текущего пользователя как имя отправителя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "subject": "Документ на согласование",
    "message": "<p>Просьба согласовать документ.<\/p>",
    "to": [
        {
            "email": "recipient@example.com",
            "name": "Иванов И.И."
        }
    ],
    "attachments": [
        {
            "file_name": "document.txt",
            "file_base64_content": "SGVsbG8="
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.email.send Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.email.send",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Системный параметр SMTP-сервера "%s" не задан. Отправка почты невозможна
Номер текущего сервера
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.server.id Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— server_id integer (10) Номер сервера

Пример ответа:

{
    "request_identifier": "alphapi.system.server.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "server_id": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Время и таймзона текущего сервера
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.server.timezone Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— utc_time string (26) Время сервера по UTC
— timezone string (255) Часовой пояс
— location string (255) Центр

Пример ответа:

{
    "request_identifier": "alphapi.system.server.timezone",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "utc_time": "2025-12-31 12:00:00",
        "timezone": "Asia\/Yekaterinburg",
        "location": "Екатеринбург"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Язык текущего сервера
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.server.language Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— language string (5) Язык сервера

Пример ответа:

{
    "request_identifier": "alphapi.system.server.language",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "language": "ru-RU"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Язык базы данных не распознан
Типы лицензий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "LT_ID = 'A'",
    "orderby": "LT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.license.types Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — LT_ID string (1) ID типа лицензии
— — Описание string (50) Описание типа лицензии

Пример ответа:

{
    "request_identifier": "alphapi.system.license.types",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LT_ID": "1",
                "Описание": "Лицензия на 1 АРМ"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать комментарий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты
comment_id integer (10) Да - ID комментария
comment string (4000) Да - Текст комментария
comment_markdown string (4000) - Комментарий с markdown-разметкой

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "comment_id": 213,
    "comment": "Комментарий",
    "comment_markdown": "Тест и *жирный текст*"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.comment.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— comment_id integer (10) ID комментария
— file_ids integer[] ID загруженных в документ файлов

Пример ответа:

{
    "request_identifier": "alphapi.system.comment.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Comment edited successfully",
    "data": {
        "comment_id": 5,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
404 Не найдено
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
1006 Комментарий не найден или недоступен текущему пользователю.
Добавить комментарий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (10) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
comment string (2048) Да - Комментарий
comment_markdown string (2048) - Комментарий с markdown-разметкой
files Массив файлов в Base64, при непустом массиве обязателен текст comment.
— file_name string Да - Имя файла
— file_content text Да - Содержимое файла в формате BASE64
— file_size integer (10) - Размер файла
— attributes string (5) - Атрибуты

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "comment": "Тест",
    "comment_markdown": "Тест и *жирный текст*"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.comment.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— comment_id integer ID комментария
— file_ids integer[] ID загруженных в документ файлов

Пример ответа:

{
    "request_identifier": "alphapi.system.comment.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "comment_id": 101,
        "file_ids": []
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 files должен быть массивом объектов с file_name и file_content.; Некорректный XML файлов резолюции. Существующие ссылки не изменены.
1001 Файл «%s» содержит некорректный Base64.; Ошибка декодирования алгоритма Base64
1002 Размер файла «%s» не совпадает с размером содержимого.
1003 Файлы поддерживаются только для комментариев документа или точки маршрута.
1004 Точка маршрута не найдена или недоступна текущему пользователю.
1005 При передаче files необходим непустой текст comment.
Удалить комментарий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
comment_id integer (10) Да - ID комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "comment_id": 2323
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.comment.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.comment.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Comment deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Разница в рабочих днях (множественная)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
items Массив элементов
— date_start date (YYYY-MM-DD) Да - Дата начала для вычисления
— date_end date (YYYY-MM-DD) Да - Конечная дата для вычисления

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "items": [
        {
            "date_start": "2021-01-15",
            "date_end": "2021-01-30"
        },
        {
            "date_start": "2021-02-01",
            "date_end": "2021-02-13"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.workdaysdiff.multiple Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— items Массив элементов
— — date_start date (Y-m-d) Дата начала
— — date_end date (Y-m-d) Конечная дата
— — count_days integer (10) Кол-во рабочих дней

Пример ответа:

{
    "request_identifier": "alphapi.system.workdaysdiff.multiple",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "date_start": "2021-01-15",
                "date_end": "2021-01-30",
                "count_days": 11
            },
            {
                "date_start": "2021-02-01",
                "date_end": "2021-02-13",
                "count_days": 10
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Входящий массив дат пуст.
1001 Входящий массив дат некорректен.
1002 Даты должны быть в формате "YYYY-MM-DD"
Получить серверное время
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.getservertime Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— date datetime (Y-m-d H:i:s) Серверное время

Пример ответа:

{
    "request_identifier": "alphapi.system.getservertime",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "date": "2026-01-01 12:34:56"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Параметры масок
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
masks varchar[] Да - Массив масок
numbers integer[] - Массив номеров параметров
sense_combined boolean 1 Учитывать комбинированные параметры

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "masks": [
        "Тема\\:Ccccccccccccccccccc\\; Дата\\:<>00.00<>\\.2\\000\\;",
        "Документ\\:Aaaaa\\; Номер\\:999999\\;"
    ],
    "numbers": [
        1,
        2
    ],
    "sense_combined": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.doc.masks.params Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— items Массив элементов
— — mask string Указанная маска
— — params Массив элементов
— — — number integer Номер параметра
— — — start integer Начальная позиция параметра в содержании
— — — end integer Конечная позиция параметра в содержании
— — — maskStart integer Начальная позиция параметра в маске
— — — maskEnd integer Конечная позиция параметра в маске
— — — maskValue text Шаблон параметра в маске

Пример ответа:

{
    "request_identifier": "alphapi.system.doc.masks.params",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "mask": "Тема\\:Ccccccccccccccccccc\\; Дата\\:<>00.00<>\\.2\\000\\;",
                "params": [
                    {
                        "number": 1,
                        "start": 6,
                        "end": 24,
                        "maskStart": 7,
                        "maskEnd": 25,
                        "maskValue": "Ccccccccccccccccccc"
                    },
                    {
                        "number": 2,
                        "start": 32,
                        "end": 36,
                        "maskStart": 35,
                        "maskEnd": 39,
                        "maskValue": "00.00"
                    }
                ]
            },
            {
                "mask": "Документ\\:Aaaaa\\; Номер\\:999999\\;",
                "params": [
                    {
                        "number": 1,
                        "start": 10,
                        "end": 14,
                        "maskStart": 11,
                        "maskEnd": 15,
                        "maskValue": "Aaaaa"
                    },
                    {
                        "number": 2,
                        "start": 23,
                        "end": 28,
                        "maskStart": 26,
                        "maskEnd": 31,
                        "maskValue": "999999"
                    }
                ]
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
113 Некорректный строковый массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Маска "%s" не содержит параметров
2000 Маска "%s" не содержит параметра с номером "%s"
Параметры маски
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
mask text Да - Маска
number integer - Номер параметра
sense_combined boolean 1 Учитывать комбинированные параметры

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "mask": "Тема\\:Ccccccccccccccccccc\\; Дата\\:<>00.00<>\\.2\\000\\;",
    "number": 1,
    "sense_combined": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.doc.mask.params Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— items Массив элементов
— — number integer Номер параметра
— — start integer Начальная позиция параметра в содержании
— — end integer Конечная позиция параметра в содержании
— — maskStart integer Начальная позиция параметра в маске
— — maskEnd integer Конечная позиция параметра в маске
— — maskValue text Шаблон параметра в маске

Пример ответа:

{
    "request_identifier": "alphapi.system.doc.mask.params",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "number": 1,
                "start": 5,
                "end": 24,
                "maskStart": 6,
                "maskEnd": 25,
                "maskValue": "Ccccccccccccccccccc"
            },
            {
                "number": 2,
                "start": 31,
                "end": 36,
                "maskStart": 34,
                "maskEnd": 39,
                "maskValue": "00.00"
            },
            {
                "number": 3,
                "start": 39,
                "end": 41,
                "maskStart": 44,
                "maskEnd": 46,
                "maskValue": "00"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Маска "%s" не содержит параметров
Копировать тип документа
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
name string (255) Да - Имя существующего типа документа
new_name string (255) Да - Имя нового типа документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "name": "Документ",
    "new_name": "Документ (копия)"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.copydoctype Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.copydoctype",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc type copied successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Статус системы автоподписи
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.autosign.status Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— status integer Статус

Пример ответа:

{
    "request_identifier": "alphapi.system.autosign.status",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "status": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Изменить системный параметр
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sp_id integer (10) Да - ID системного параметра
value string (255) Да - Новое значение параметра

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "sp_id": 10,
    "value": "123"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.params.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— sp_id integer (10) ID системного параметра

Пример ответа:

{
    "request_identifier": "alphapi.system.params.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "System parameter edited successfully",
    "data": {
        "sp_id": 10
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Системные параметры
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Параметр = 'A'",
    "orderby": "Параметр ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.params.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — SP_ID integer (10) ID параметра
— — Параметр string (255) Название параметра
— — Значение string (255) Значение параметра
— — Значения string (255) Допустимые значения параметра (разделенные символом амперсанда)

Пример ответа:

{
    "request_identifier": "alphapi.system.params.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 26,
                "SP_ID": 34,
                "Параметр": "Расширение файла подписи",
                "Значение": ".p7s",
                "Значения": ".p7s&.sig&.sgn"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Максимальные длины строковых полей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.params.fields.length.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Длины колонок в символах
— content_string integer Максимальная длина поля содержания документа
— audit_string integer Максимальная длина поля аудита
— lcontent_string integer Максимальная длина поля маска типа документа

Пример ответа:

{
    "request_identifier": "alphapi.system.params.fields.length.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "content_string": 800,
        "audit_string": 960,
        "lcontent_string": 1504
    }
}
Описание
Длины колонок текущей БД в символах. Значение -1 означает отсутствие объявленного ограничения длины, null — недоступность метаданных колонки.
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить зашифрованный системный параметр
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sp_id integer (10) Да - ID системного параметра

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "sp_id": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.params.encrypted.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— value string (2048) Зашифрованное значение параметра

Пример ответа:

{
    "request_identifier": "alphapi.system.params.encrypted.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": {
            "value": "5ZbjcUVwJX4="
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
401 Токен неизвестен, либо его срок действия истек.
Редактирование файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer (10) Да - ID редактируемого файла
file_name string Да - Имя файла
file_edition integer (3) - Номер ревизии
comment string (255) - Комментарий
attributes string (5) - Атрибуты

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 123,
    "file_name": "some-file-name.jpg",
    "file_edition": 1,
    "comment": null,
    "attributes": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— f_id integer ID файла

Пример ответа:

{
    "request_identifier": "alphapi.system.file.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "f_id": 123
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить файл с содержимым
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
file_content text Да - Содержимое файла в формате BASE64
file_name string Да - Имя файла
file_size integer (10) - Размер файла
file_edition integer (3) - Номер ревизии
comment string (255) - Комментарий
attributes string (5) - Атрибуты

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "file_content": "DSLFDSJHLKFRJJGSGORIVSBFDGFGDFLGKJFKGJLFDJGLFKDJ",
    "file_name": "some-file-name.jpg",
    "file_size": 1234567890,
    "file_edition": 1,
    "comment": null,
    "attributes": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.add.with.content Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_id integer ID файла

Пример ответа:

{
    "request_identifier": "alphapi.system.file.add.with.content",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Ошибка декодирования алгоритма Base64
Добавить файл с правками
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
file_name string Да - Имя файла. Расширение заменяется на « (правки).pdf», « (edits).pdf» или « (révisions).pdf» по языку базы. Существующий постфикс любого из трех языков сохраняется. При превышении 50 символов основа сокращается с добавлением «...», постфикс сохраняется целиком.
comment string (255) - Комментарий. Сохраняется переданное значение без добавления имени файла или постфикса.
attributes string (5) - Атрибуты
file_edits Правки
— page_url string Да - Ссылка на исходное изображение
— page_edits_svg string Да - SVG-слой правок

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "file_name": "some-file-name.jpg",
    "comment": null,
    "attributes": "",
    "file_edits": [
        {
            "page_url": "https:\/\/storage04.alpha-doc.ru\/web\/some-file-name-1.jpg",
            "page_edits_svg": "<svg><\/svg>"
        },
        {
            "page_url": "https:\/\/storage04.alpha-doc.ru\/web\/some-file-name-2.jpg",
            "page_edits_svg": "<svg><\/svg>"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.add.with.edits Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_id integer ID файла

Пример ответа:

{
    "request_identifier": "alphapi.system.file.add.with.edits",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Невалидный svg-файл; Ошибка декодирования алгоритма Base64; Язык базы данных не распознан
1002 Ошибка преобразования в pdf: "%s"
1003 Ошибка добавления файла с правками: "%s"
1004 Файл не найден: "%s"
1005 Файл не сохранен: "%s"
1006 Ошибка Imagick: "%s"
1007 Недопустимый URL исходного изображения: "%s"
Метаданные по файлу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_hash string Да - Хеш файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_hash": "0A4BB28F7C07FAA3424DF3342DAABBA1184"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.meta.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Массив данных
— count_pages integer Кол-во страниц

Пример ответа:

{
    "request_identifier": "alphapi.system.file.meta.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "count_pages": 7
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
401 Токен неизвестен, либо его срок действия истек.
1001 Файл с мета данными "%s" не найден
1002 Ошибка считывания файла с мета данными
Пометить файл как скопированный
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer Да - 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 Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.file.markascopied",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить просмотр файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_ids integer[] (10) Да - Массив ID файлов

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_ids": [
        101,
        777
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.addview Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.file.addview",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить подпись
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
f_id integer (10) Да - ID файла
sign_content text Да - Содержимое подписи в формате BASE64
sign_type string (255) Да - Тип подписи (может принимать значения: P7S, CRC32)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "f_id": 121,
    "sign_content": "DSLFDSJHLKFRJJGSGORIVSBFDGFGDFLGKJFKGJLFDJGLFKDJ",
    "sign_type": "CRC32"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.sign Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_id integer ID файла подписи

Пример ответа:

{
    "request_identifier": "alphapi.system.file.sign",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Тип подписи неизвестен; Ошибка декодирования алгоритма Base64
1002 Входящий массив пуст
1003 Файлы с ID [%s] не найдены
Добавить файл
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
file_path string (255) Да - Относительный путь файла
file_name string Да - Имя файла
file_size integer Да - Размер файла
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 Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_id integer ID файла

Пример ответа:

{
    "request_identifier": "alphapi.system.file.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получение файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer Да - 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 Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— 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",
    "data": {
        "file_base64": "SFSFHLHSAAAFDASFDFSDFHOUEFLNSLKDNFSLJDBFSDKGFLGSDF"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
401 Токен неизвестен, либо его срок действия истек.
1001 Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002 Файл с ID "%u" не найден
Получить следующую редакцию файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer (10) Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer (10) Да - ID сущности
name varchar Да - Имя файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 123,
    "name": "Таблица.xls"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.edition.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_edition integer (10) Редакция файла

Пример ответа:

{
    "request_identifier": "alphapi.system.file.edition.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "file_edition": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить запись о файле
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer (10) Да - ID файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 534
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.delete Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.file.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "File deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить подпись (множественную)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
items Массив элементов
— f_id integer (10) Да - ID файла
— sign_content text Да - Содержимое подписи в формате BASE64
— sign_type string (255) Да - Тип подписи (может принимать значения: P7S, CRC32)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "items": [
        {
            "f_id": 121,
            "sign_content": "DSLFDSJHLKFRJJGSGORIVSBFDGFGDFLGKJFKGJLFDJGLFKDJ",
            "sign_type": "CRC32"
        },
        {
            "f_id": 122,
            "sign_content": "XXDSLFDSJHLKFRJJGSGORIVSBFDGFGDFLGKJFKGJLFDJGLFKDJ",
            "sign_type": "P7S"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.sign.multiple Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_ids integer[] ID файлов подписи

Пример ответа:

{
    "request_identifier": "alphapi.system.file.sign.multiple",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_ids": [
            12448,
            12449
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Ошибка декодирования алгоритма Base64; Тип подписи неизвестен
1002 Входящий массив пуст
1003 Файлы с ID [%s] не найдены
Обновить информацию о пользователях
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.data.update Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.system.data.update",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "System data updates successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить системную дату
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.get.date Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— date datetime (Y-m-d H:i:s) Системная дата

Пример ответа:

{
    "request_identifier": "alphapi.system.get.date",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "System date is 2022-03-30 15:51:07",
    "data": {
        "items": {
            "date": "2022-03-30 15:51:07"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Срок в рабочих днях
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
date_start date (YYYY-MM-DD) - Дата, с которой посчитать срок в рабочих днях (если указывается точная дата, иначе NULL если срок указывается с текущего дня)
count_day integer (10) Да - Сколько рабочих дней добавить к дате

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_day": 3
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.get.deadline Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
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"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить время из даты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
date datetime (Y-m-d H:i:s) - Исходная дата/время

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "date": "2026-01-01 12:34:56"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.gettimeex Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— time datetime (Y-m-d H:i:s) Время в формате 1900-01-01 HH:MM:SS

Пример ответа:

{
    "request_identifier": "alphapi.system.gettimeex",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "time": "1900-01-01 12:34:56"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
ID системного пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.user.id Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— login_id integer (10) ID пользователя

Пример ответа:

{
    "request_identifier": "alphapi.system.user.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "login_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Служебные данные по комментарию
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
comment_id integer (10) Да - ID комментария
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "comment_id": 134,
    "where": "Дата время = 'A'",
    "orderby": "Дата время ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.comment.comments.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — COMMENT_ID integer (10) ID комментария
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — Дата время datetime (Y-m-d H:i:s) Дата и время комментария
— — Текст string (2048) Текст комментария. Для служебного комментария — содержимое DATA
— — Hash string (32) Хеш служебного комментария
— — TYPE_ID integer (1) ID типа служебного комментария (1 - данные файлов в комментарии, 2 - данные точки маршрута, 3 - данные маршрута, 4 - данные markdown)
— — Пользователь string (255) Ф.И.О. пользователя, который создал комментарий

Пример ответа:

{
    "request_identifier": "alphapi.comment.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 11,
                "COMMENT_ID": 1014,
                "PARENT_TABLE_ID": 11,
                "PARENT_ID": 1013,
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "\n<xml>Данные файлов<\/xml>\n",
                "Hash": "41C24B8A9FA64C61CBA3C090BCDA2C9E",
                "TYPE_ID": 1,
                "Пользователь": "Сидоров С.С."
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Доступные элементы GUI
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "GUIE_ID = 'A'",
    "orderby": "GUIE_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.available.gui.elements.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — GUIE_ID integer (10) ID элемента
— — ROLE_ID integer (10) ID роли
— — Описание string (255) Описание элемента

Пример ответа:

{
    "request_identifier": "alphapi.available.gui.elements.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "GUIE_ID": 31,
                "ROLE_ID": 11,
                "Описание": "Контрагенты. Редактирование"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы дней для производственного календаря
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.day.types.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DT_ID integer (10) ID типа дня
— — Название string (1, 50) Название
— — Примечание string (0, 255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.day.types.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DT_ID": 3,
                "Название": "Выходной",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Служебные данные по комментариям
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
comment_ids integer[] (10) Да - Массив ID комментариев (не более 100)
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "comment_ids": [
        134,
        135
    ],
    "where": "Дата время = 'A'",
    "orderby": "Дата время ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.comments.comments.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — COMMENT_ID integer (10) ID комментария
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — Дата время datetime (Y-m-d H:i:s) Дата и время комментария
— — Текст string (2048) Текст комментария. Для служебного комментария — содержимое DATA
— — Hash string (32) Хеш служебного комментария
— — TYPE_ID integer (1) ID типа служебного комментария (1 - данные файлов в комментарии, 2 - данные точки маршрута, 3 - данные маршрута, 4 - данные markdown)
— — Пользователь string (255) Ф.И.О. пользователя, который создал комментарий

Пример ответа:

{
    "request_identifier": "alphapi.comments.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 11,
                "COMMENT_ID": 1014,
                "PARENT_TABLE_ID": 11,
                "PARENT_ID": 1013,
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "\n<xml>Данные файлов<\/xml>\n",
                "Hash": "41C24B8A9FA64C61CBA3C090BCDA2C9E",
                "TYPE_ID": 1,
                "Пользователь": "Сидоров С.С."
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
114 Переданный лимит не может быть выше %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
120 Значение поля "%s" должно быть положительным
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Комментарии. Индекс
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "COMMENT_ID = 'A'",
    "orderby": "COMMENT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.comments.index.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (10) ID таблицы
— — COMMENT_ID integer (10) ID комментария
— — PARENT_TABLE_ID integer (3) ID родительской таблицы
— — PARENT_ID integer (10) ID родителя
— — Раздел string (50) Раздел
— — Объект string (4000) Объект
— — Дата datetime (Y-m-d H:i:s) Дата
— — Индекс string (4000) Индекс

Пример ответа:

{
    "request_identifier": "alphapi.comments.index.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 5,
                "PARENT_TABLE_ID": 5,
                "PARENT_ID": 5,
                "Раздел": "Должности",
                "Объект": "Бухгалтер",
                "Дата": "2001-01-01 01:01:01",
                "Индекс": "индекс"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Конфигурация для сравнения двух файлов в onlyoffice
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer (10) Да - ID файла
file_prev_key string (32) - Хеш прошлого незаконченного редактирования
compare_file_id integer (10) Да - ID файла для сравнения

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 555,
    "compare_file_id": 777
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.onlyoffice.config.compare.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Ответ метода
— url string Адрес onlyoffice
— config Конфигурация onlyoffice
— — document Описание документа
— — — fileType varchar (4) Тип файла
— — — key integer (10) Уникальный ключ редактирования
— — — referenceData Описание файла
— — — — fileKey varchar (4) Уникальный ключ для файла
— — — — key varchar (4) Уникальный ключ для файла и редакции
— — — title varchar (255) Имя файла
— — — url varchar (255) Путь к файлу
— — — info Описание владельца
— — — — owner varchar (255) Автор документа
— — — — uploaded datetime (Y-m-d H:i) Дата загрузки документа в БД
— — — permissions Права
— — — — chat boolean (1) Право ведения чата
— — — — comment boolean (1) Право комментирования
— — — — protect boolean (1) Право защиты файла
— — — — review boolean (1) Право предпросмотра
— — editorConfig Описание редактора
— — — lang varchar (2) Язык
— — — mode varchar (32) Режим
— — — user Описание пользователя
— — — — name varchar (255) ФИО пользователя
— — — — id integer (10) ID пользователя
— — — customization Настройка
— — — — autosave boolean (1) Автосохранение
— — — — comments boolean (1) Комментарии
— — — — feedback Обратная связь
— — — — — url varchar (255) Адрес страницы обратной связи
— — — — — visible boolean (1) Видимость ссылки
— — — — plugins boolean (1) Расширения
— — — — uiTheme varchar (255) Тема оформления
— — — — features Функции
— — — — — featuresTips boolean (1) Всплывающие подсказки по функциям
— — — permissions Права
— — — — chat boolean (1) Право ведения чата
— — — — comment boolean (1) Право комментирования
— — — — protect boolean (1) Право защиты файла
— — — — review boolean (1) Право предпросмотра
— — token varchar (36) Токен проверки конфигурации
— — document_compare Описание документа, с которым сравнивают
— — — fileType varchar (4) Тип файла, с которым сравнивают
— — — title varchar (255) Имя файла, с которым сравнивают
— — — url varchar (255) Путь к файлу, с которым сравнивают

Пример ответа:

{
    "request_identifier": "alphapi.onlyoffice.config.compare.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "config": {
            "document": {
                "fileType": "doc",
                "key": "EDIT_KEY",
                "referenceData": {
                    "fileKey": "FILE_KEY",
                    "key": "FILE_REVISION_KEY"
                },
                "title": "сайт.doc",
                "url": "https:\/\/storage04.alpha-doc.ru\/web\/835B3999768BBE3C6A14B3528E394364.doc",
                "info": {
                    "owner": "Автор документа",
                    "uploaded": "2010-07-07 3:46 PM"
                },
                "permissions": {
                    "chat": false,
                    "comment": false,
                    "protect": false,
                    "review": false
                }
            },
            "editorConfig": {
                "lang": "ru",
                "mode": "edit",
                "user": {
                    "name": "Иванов Иван Иванович",
                    "id": 123
                },
                "customization": {
                    "autosave": false,
                    "comments": false,
                    "feedback": {
                        "url": "https:\/\/alpha-doc.ru",
                        "visible": true
                    },
                    "plugins": false,
                    "uiTheme": "theme-classic-light",
                    "features": {
                        "featuresTips": false
                    }
                }
            },
            "token": "config-jwt-token",
            "document_compare": {
                "fileType": "doc",
                "title": "сайт_сравнение.doc",
                "url": "https:\/\/storage04.alpha-doc.ru\/web\/115B3999768BBE3C6A14B3528E394311.doc"
            }
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002 Файл с ID "%u" не найден
Конфигурация для редактирования файлов в onlyoffice
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer (10) Да - ID файла
file_prev_key string (32) - Хеш прошлого незаконченного редактирования

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 555
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.onlyoffice.config.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Ответ метода
— url string Адрес onlyoffice
— config Конфигурация onlyoffice
— — document Описание документа
— — — fileType varchar (4) Тип файла
— — — key integer (10) Уникальный ключ редактирования
— — — referenceData Описание файла
— — — — fileKey varchar (4) Уникальный ключ для файла
— — — — key varchar (4) Уникальный ключ для файла и редакции
— — — title varchar (255) Имя файла
— — — url varchar (255) Путь к файлу
— — — info Описание владельца
— — — — owner varchar (255) Автор документа
— — — — uploaded datetime (Y-m-d H:i) Дата загрузки документа в БД
— — — permissions Права
— — — — chat boolean (1) Право ведения чата
— — — — comment boolean (1) Право комментирования
— — — — protect boolean (1) Право защиты файла
— — — — review boolean (1) Право предпросмотра
— — editorConfig Описание редактора
— — — lang varchar (2) Язык
— — — mode varchar (32) Режим
— — — user Описание пользователя
— — — — name varchar (255) ФИО пользователя
— — — — id integer (10) ID пользователя
— — — customization Настройка
— — — — autosave boolean (1) Автосохранение
— — — — comments boolean (1) Комментарии
— — — — feedback Обратная связь
— — — — — url varchar (255) Адрес страницы обратной связи
— — — — — visible boolean (1) Видимость ссылки
— — — — plugins boolean (1) Расширения
— — — — uiTheme varchar (255) Тема оформления
— — — — features Функции
— — — — — featuresTips boolean (1) Всплывающие подсказки по функциям
— — — permissions Права
— — — — chat boolean (1) Право ведения чата
— — — — comment boolean (1) Право комментирования
— — — — protect boolean (1) Право защиты файла
— — — — review boolean (1) Право предпросмотра
— — token varchar (36) Токен проверки конфигурации

Пример ответа:

{
    "request_identifier": "alphapi.onlyoffice.config.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "config": {
            "document": {
                "fileType": "doc",
                "key": "EDIT_KEY",
                "referenceData": {
                    "fileKey": "FILE_KEY",
                    "key": "FILE_REVISION_KEY"
                },
                "title": "сайт.doc",
                "url": "https:\/\/storage04.alpha-doc.ru\/web\/835B3999768BBE3C6A14B3528E394364.doc",
                "info": {
                    "owner": "Автор документа",
                    "uploaded": "2010-07-07 3:46 PM"
                },
                "permissions": {
                    "chat": false,
                    "comment": false,
                    "protect": false,
                    "review": false
                }
            },
            "editorConfig": {
                "lang": "ru",
                "mode": "edit",
                "user": {
                    "name": "Иванов Иван Иванович",
                    "id": 123
                },
                "customization": {
                    "autosave": false,
                    "comments": false,
                    "feedback": {
                        "url": "https:\/\/alpha-doc.ru",
                        "visible": true
                    },
                    "plugins": false,
                    "uiTheme": "theme-classic-light",
                    "features": {
                        "featuresTips": false
                    }
                }
            },
            "token": "config-jwt-token"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002 Файл с ID "%u" не найден
1100 Переданный параметр "file_prev_key" не валидный по длине. Ожидается 32 символа a-z0-9
Часовые пояса
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Разница = 'A'",
    "orderby": "Разница ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.timezones.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TZ_ID integer (10) ID часового пояса
— — Знак boolean Знак разницы с GMT (true = минус, false = плюс)
— — Разница datetime (Y-m-d H:i:s) Разница с GMT
— — Описание string (255) Описание часового пояса
— — Примечание string (255) Примечание
— — ОписаниеПолное string (517) Полное описание
— — ОписаниеКраткое string (261) Краткое описание

Пример ответа:

{
    "request_identifier": "alphapi.timezones.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TZ_ID": 5,
                "Знак": true,
                "Разница": "1900-01-01 03:00:00.000000",
                "Описание": "Москва, Санкт-Петербург, Волгоград, Баку, Ереван",
                "Примечание": null,
                "ОписаниеПолное": "(GMT+03:00:00) Москва, Санкт-Петербург, Волгоград, Баку, Ереван",
                "ОписаниеКраткое": "(МСК-00:00:00)"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Рабочий календарь
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Тип дня = 'A'",
    "orderby": "Тип дня ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.calendar.int.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DAY_ID integer (10) ID дня
— — DT_ID integer (10) Тип дня
— — Дата date (Y-m-d H:i:s) Дата
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.calendar.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DAY_ID": 6,
                "DT_ID": 2,
                "Дата": "2001-01-01 01:01:01",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Шлюз получения уникальных значений
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
endpoint string (255) Да - Целевой GET-метод, из которого будут получены уникальные значения. Только URI
proxy_distinct_fields varchar[] (255) Да - Массив полей целевого метода, по которым нужно получить уникальные ненулевые значения. Поля должны быть объявлены в выходном массиве данных целевого метода
proxy_params Массив параметров целевого метода
— some_id integer - Параметры целевого метода
— some_string string - Параметры целевого метода
proxy_filter Фильтрация JSON вместо параметра where
— logic string Да - Допустимые значения: "AND", "OR"
— conditions Группа условий
— — field string Да - Поле фильтрации
— — operator string Да - Оператор фильтрации. Допустимые значения: "EQUALS","NOT_EQUALS","GREATER","LESS","GREATER_OR_EQUAL","LESS_OR_EQUAL","NOT_CONTAINS","CONTAINS","STARTS_WITH","ENDS_WITH","IN","NOT_IN","RANGE","TODAY","YESTERDAY","LAST_7_DAYS","LAST_30_DAYS","EMPTY","NOT_EMPTY","TRUE","FALSE"
— — value string Да - Значение. Может быть числом, строкой, массивом
proxy_limit integer - Параметр совместимости с gateway/execute. В distinct-запросе не используется, так как метод возвращает все уникальные значения
proxy_offset integer - Параметр совместимости с gateway/execute. В distinct-запросе не используется
proxy_orderby Параметр совместимости с gateway/execute. В distinct-запросе не используется
— field string - Поле сортировки
— direction string - Направление сортировки. Допустимые значения: "ASC","DESC"

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "endpoint": "\/docs\/get\/",
    "proxy_distinct_fields": [
        "Проект",
        "Статус"
    ],
    "proxy_params": {
        "some_id": 123,
        "some_string": "test"
    },
    "proxy_filter": {
        "logic": "AND",
        "conditions": [
            {
                "field": "DOC_ID",
                "operator": "EQUALS",
                "value": 100
            }
        ]
    },
    "proxy_limit": 1,
    "proxy_offset": 0,
    "proxy_orderby": [
        {
            "field": "DOC_ID",
            "direction": "DESC"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.gateway.aggregate.distinct Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— items Объект, где ключи первого уровня - запрошенные поля, значения - массивы уникальных ненулевых значений
— — Проект varchar[] (255) Уникальные значения поля "Проект"
— — Статус varchar[] (255) Уникальные значения поля "Статус"

Пример ответа:

{
    "request_identifier": "alphapi.gateway.aggregate.distinct",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of distinct values 4.",
    "data": {
        "items": {
            "Проект": [
                "Договора",
                "Поручения"
            ],
            "Статус": [
                "В работе",
                "Исполнен"
            ]
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
113 Некорректный строковый массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
135 Некорректный список полей "%s". Допустимые поля: %s
136 Класс документации целевого метода "%s" не найден
137 Класс документации целевого метода "%s" должен наследовать CDocflow_Documentations_AbstractGetter
138 Класс документации целевого метода "%s" имеет неподдерживаемую структуру описания выходных полей
139 Целевой метод "%s" не поддерживает получение базового SQL-запроса для gateway-агрегации
401 Токен неизвестен, либо его срок действия истек.
2001 Недопустимое поле: %s
2002 Неподдерживаемый оператор: %s
2003 Некорректное значение для оператора: %s
2004 Неподдерживаемый тип базы данных: %s
2005 Некорректный тип поля: %s
2006 Ошибка преобразования: %s
2007 Некорректный логический оператор: %s
Шлюз выполнения запросов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
endpoint string (255) Да - Целевой метод, который будет вызван. Только URI
proxy_params Массив параметров целевого метода
— some_id integer - Параметры целевого метода
— some_string string - Параметры целевого метода
proxy_filter Фильтрация JSON вместо параметра where
— logic string Да - Допустимые значения: "AND", "OR"
— conditions Группа условий
— — field string Да - Поле фильтрации
— — operator string Да - Оператор фильтрации. Допустимые значения: "EQUALS","NOT_EQUALS","GREATER","LESS","GREATER_OR_EQUAL","LESS_OR_EQUAL","NOT_CONTAINS","CONTAINS","STARTS_WITH","ENDS_WITH","IN","NOT_IN","RANGE","TODAY","YESTERDAY","LAST_7_DAYS","LAST_30_DAYS","EMPTY","NOT_EMPTY","TRUE","FALSE"
— — value string Да - Значение. Может быть числом, строкой, массивом
proxy_limit integer - Ограничение кол-ва запрашиваемых строк
proxy_offset integer - Смещение запрашиваемых строк
proxy_orderby Массив параметров сортировки
— field string - Поле сортировки
— direction string - Направление сортировки. Допустимые значения: "ASC","DESC"

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "endpoint": "\/docs\/get\/",
    "proxy_params": {
        "some_id": 123,
        "some_string": "test"
    },
    "proxy_filter": {
        "logic": "AND",
        "conditions": [
            {
                "field": "DOC_ID",
                "operator": "EQUALS",
                "value": 100
            }
        ]
    },
    "proxy_limit": 1,
    "proxy_offset": 0,
    "proxy_orderby": [
        {
            "field": "DOC_ID",
            "direction": "DESC"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.gateway.execute Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета limit. Поле присутствует, если целевой метод вернул count.
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DOC_ID integer (10) ID документа
— — REGISTRAR_ID integer (10) ID логина пользователя, создавшего документ
— — CONTROLLER_ID integer (10) ID логина пользователя контролера документа
— — DS_ID integer (10) ID статуса документа
— — DT_ID integer (10) ID типа документа
— — Тип string (50) Тип документа
— — Активен boolean (1) Флаг активности документа (документ может быть неактивным, если это черновик или на паузе)
— — Статус string (255) Статус документа
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта
— — Содержание string (255) Содержание документа
— — Содержание_MASK string (480) Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание
— — Содержание_MASK_PARAMS string (1024) Содержит информацию о параметрах документа, которые сохранены в его содержании
— — Содержание_MASK_COND string (261) Содержит информацию об условии, которое нужно применить при поиске документов данного типа
— — Запуск datetime (Y-m-d H:i:s) Дата автоматического запуска документа в работу, если установлен отсроченный запуск
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Регистрация datetime (Y-m-d H:i:s) Дата регистрации документа, если эта функция используется
— — Рег.номер string (50) Регистрационный номер документа, если эта функция используется
— — Комментарий string (255) Комментарий документа

Пример ответа:

{
    "request_identifier": "alphapi.gateway.execute",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DOC_ID": 101,
                "REGISTRAR_ID": 101,
                "CONTROLLER_ID": 101,
                "DS_ID": 101,
                "DT_ID": 101,
                "Тип": "Уведомление",
                "Активен": 1,
                "Статус": "Просрочен",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Договора",
                "Содержание": "Содержание документа",
                "Содержание_MASK": "",
                "Содержание_MASK_PARAMS": "",
                "Содержание_MASK_COND": "DT_ID=101",
                "Запуск": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "101",
                "Комментарий": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
136 Класс документации целевого метода "%s" не найден
137 Класс документации целевого метода "%s" должен наследовать CDocflow_Documentations_AbstractGetter
401 Токен неизвестен, либо его срок действия истек.
2001 Недопустимое поле: %s
2002 Неподдерживаемый оператор: %s
2003 Некорректное значение для оператора: %s
2004 Неподдерживаемый тип базы данных: %s
2005 Некорректный тип поля: %s
2006 Ошибка преобразования: %s
2007 Некорректный логический оператор: %s
Активировать все события
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.events.all.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.events.all.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать все события
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.events.all.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.events.all.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить дату файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
f_id integer (10) Да - ID файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "f_id": 102280
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.file.date.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_date datetime (Y-m-d H:i:s) Дата файла

Пример ответа:

{
    "request_identifier": "alphapi.file.date.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "File date is 2024-07-02 12:18:47",
    "data": {
        "items": {
            "file_date": "2024-07-02 12:18:47"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить атрибуты файла по хешу файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_hash string (255) Да - Хеш файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_hash": "5C84727F1D36C1096392339469B90C35"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.file.attributes.byname.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_attributes string (5) Атрибуты файла

Пример ответа:

{
    "request_identifier": "alphapi.file.attributes.byname.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "File attributes is EA",
    "data": {
        "items": {
            "file_attributes": "EA"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить атрибуты файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
f_id integer (10) Да - ID файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "f_id": 102403
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.file.attributes.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— file_attributes string (5) Атрибуты файла

Пример ответа:

{
    "request_identifier": "alphapi.file.attributes.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "File attributes is EA",
    "data": {
        "items": {
            "file_attributes": "EA"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Счетчики основных разделов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
commissions_list text (4000) - Список ID поручений (разделенных запятыми)
doc_list text (4000) - Список ID документов (разделенных запятыми)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "commissions_list": null,
    "doc_list": null
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.my.sysviews.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— commissions_count integer Количество поручений
— uc_count integer Количество документов на контроле

Пример ответа:

{
    "request_identifier": "alphapi.my.sysviews.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "System views returned successfully",
    "data": {
        "items": {
            "commissions_count": 2,
            "uc_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество реплицированных объектов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.my.old.replication.data.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— my_old_replication_data_count integer Количество реплицированных объектов

Пример ответа:

{
    "request_identifier": "alphapi.my.old.replication.data.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My old replication data count is 2",
    "data": {
        "items": {
            "my_old_replication_data_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Файлы текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Файл = 'A'",
    "orderby": "Файл ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.my.files.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — F_ID integer (10) ID файла
— — Название string (255) Название файла
— — Редакция integer (3) Редакция файла
— — Файл string (255) Путь к файлу в хранилище данных
— — Примечание string (255) Примечание к файлу
— — Создан datetime (Y-m-d H:i:s) Дата и время создания файла
— — Скопирован datetime (Y-m-d H:i:s) Дата и время завершения копирования файла в хранилище
— — Атрибуты string (5) Атрибуты файла, флаги архивирования и шифрования

Пример ответа:

{
    "request_identifier": "alphapi.my.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "Название": "Название файла",
                "Редакция": 3,
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": "Примечание к файлу",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Атрибуты": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Сформировать цифровой штрих-код объекта
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
table_id integer (3) Да - ID таблицы
id integer (10) Да - ID объекта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "table_id": 44,
    "id": 101265
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.format.code Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— code string (255) Цифровой штрих-код объекта

Пример ответа:

{
    "request_identifier": "alphapi.format.code",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Code is 4400101265",
    "data": {
        "items": {
            "code": "4400101265"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Роли и их GUI элементы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "ROLE_ID = 'A'",
    "orderby": "ROLE_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.roles.gui.elements.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — Key string (255) Составной ключ GUIE_ID#ROLE_ID
— — GUIE_ID integer (10) ID GUI элемента
— — Описание string (255) Описание GUI элемента
— — ROLE_ID integer (10) ID роли

Пример ответа:

{
    "request_identifier": "alphapi.roles.gui.elements.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Key": "5#2",
                "GUIE_ID": 5,
                "Описание": "Документы. Редактирование",
                "ROLE_ID": 2
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активировать событие аудита
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
et_id integer (10) Да - ID типа события

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "et_id": 15
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.event.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.event.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать событие аудита
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
et_id integer (10) Да - ID типа события

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "et_id": 15
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.event.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.event.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы событий
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Описание = 'A'",
    "orderby": "Описание ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.event.types.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — ET_ID integer (10) ID типа события
— — Активно boolean (1) Флаг, осуществлять ли логирование данного события
— — Приоритет integer (10) Приоритет
— — Описание string (255) Описание типа события
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.event.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "ET_ID": 15,
                "Активно": 1,
                "Приоритет": 5,
                "Описание": "Информация о входе в систему",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получение счётчиков хранилища
URL:
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.storage.counters.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— globalConnectionLimit integer (3) Глобальный лимит запросов
— globalConnectionValue integer (3) Текущее количество глобальных запросов
— methodConnectionLimit integer (3) Лимит запросов к методу
— methodConnectionValue integer (3) Текущее количество запросов к методу
— failsLimit integer (3) Лимит неуспешных запросов пользователя
— failsBanSeconds integer (3) Кол-во секунд бана пользователя после достижения порога лимита неуспешных запросов
— failsValue integer (3) Текущее значение неуспешных запросов пользователя

Пример ответа:

{
    "request_identifier": "alphapi.storage.counters.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "globalConnectionLimit": 100,
        "globalConnectionValue": 10,
        "methodConnectionLimit": 100,
        "methodConnectionValue": 10,
        "failsLimit": 5,
        "failsBanSeconds": 1800,
        "failsValue": 0
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Пользователь
Файлы пользователей
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "F_ID = 'A'",
    "orderby": "F_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.files.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — F_ID integer (10) ID файла
— — PARENT_ID integer (10) ID сущности
— — LOGIN_ID integer (10) ID пользователя
— — Название string (59) Название файла
— — Редакция integer (3) Редакция файла
— — Файл string (255) Путь к файлу в хранилище данных
— — Примечание string (5) Примечание к файлу
— — Создан datetime (Y-m-d H:i:s) Дата и время создания файла
— — Скопирован datetime (Y-m-d H:i:s) Дата и время завершения копирования файла в хранилище
— — Атрибуты string (255) Атрибуты файла, флаги архивирования и шифрования

Пример ответа:

{
    "request_identifier": "alphapi.users.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "PARENT_ID": 101,
                "LOGIN_ID": 101,
                "Название": "Документ.doc",
                "Редакция": 3,
                "Файл": "7C07B005FD61A52253CCDDDD4205337F",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Атрибуты": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Количество должностей пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.my.positions.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— my_positions_count integer Количество должностей пользователя

Пример ответа:

{
    "request_identifier": "alphapi.my.positions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My positions count is 2",
    "data": {
        "items": {
            "my_positions_count": 2
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Роли текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Роль = 'A'",
    "orderby": "Роль ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.current.user.roles.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — ROLE_ID integer ID роли
— — Роль varchar Название роли

Пример ответа:

{
    "request_identifier": "alphapi.current.user.roles.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "ROLE_ID": 2,
                "Роль": "Администратор"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активировать пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (1, 10) Да - ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.user.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
ФИО пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (10) - ID пользователя(если не передано возвращается ФИО текущего пользователя)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 8
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.fio Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— user_fio varchar (255) ФИО пользователя

Пример ответа:

{
    "request_identifier": "alphapi.user.fio",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "user_fio": "Петров Алексей Григорьевич"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
ID текущего пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.id Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— login_id integer (10) ID пользователя

Пример ответа:

{
    "request_identifier": "alphapi.user.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "login_id": 101
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (10) Да - ID пользователя
name string (255) Да - ФИО
position string (255) - Должность
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 543,
    "name": "Петр",
    "position": "Тестировщик",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— login_id integer (10) ID пользователя

Пример ответа:

{
    "request_identifier": "alphapi.user.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User edited successfully",
    "data": {
        "login_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (1, 10) Да - ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.user.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить имя пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.name.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— user_name string Имя пользователя

Пример ответа:

{
    "request_identifier": "alphapi.user.name.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User name is Developer-1 \/Разработчик\/",
    "data": {
        "items": {
            "user_name": "Developer-1 \/Разработчик\/"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать мой почтовый адрес
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
email string (255) Да - Электронный адрес
type integer (1) Да - Тип адреса (0 - адрес по умолчанию, 1 - адрес для уведомлений электронного секретаря)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "email": "test@example.com",
    "type": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.email.address.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.user.email.address.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My email address edited successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Получить должность пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (10) Да - ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 102
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.position.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— user_position string Должность пользователя

Пример ответа:

{
    "request_identifier": "alphapi.user.position.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User position is бух690419",
    "data": {
        "items": {
            "user_position": "бух690419"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
404 Должность для пользователя не найдена
Пользовательские группы
Редактировать пользовательскую группу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
group_id integer (10) Да - ID пользовательской группы
group_name string (50) Да - Название пользовательской группы
comment string (255) - Примечание
can_be_used_in_route boolean (1) - Флаг возможности использования для маршрута

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "group_id": 24,
    "group_name": "Бухгалтеры",
    "comment": "комментарий",
    "can_be_used_in_route": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— group_id integer (10) ID пользовательской группы

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User group edited successfully",
    "data": {
        "group_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Сменить основную группу пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (10) Да - ID пользователя
group_id integer (10) Да - ID пользовательской группы

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 5,
    "group_id": 7
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.primary.change Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.primary.change",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User primary group changed successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Основная группа пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
login_id integer (10) Да - ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 5
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.primary.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— group_name varchar (255) Основная группа пользователя

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.primary.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "group_name": "Бухгалтеры"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить пользователя в группу
URL:
Эмулятор
Удалить пользователя из группы
URL:
Эмулятор
Добавить пользовательскую группу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
group_name string (50) Да - Название пользовательской группы
comment string (255) - Примечание
can_be_used_in_route boolean (1) - Флаг возможности использования для маршрута

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "group_name": "Бухгалтеры",
    "comment": "комментарий",
    "can_be_used_in_route": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— group_id integer (10) ID пользовательской группы

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User group added successfully",
    "data": {
        "group_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Группы с пользователями (расширенные)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Логин = 'A'",
    "orderby": "Логин ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — GROUP_TABLE_ID integer (3) ID таблицы групп пользователей
— — USERS_TABLE_ID integer (3) ID таблицы пользователей
— — LOGIN_ID integer (10) ID пользователя
— — GROUP_ID integer (10) ID группы пользователя
— — ЛогинФИО string (564) Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — ФИО string (255) Ф.И.О. пользователя
— — Логин string (50) Логин пользователя
— — Основная группа string (50) Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — Название string (50) Название группы пользователей
— — Активный boolean (1) Флаг активности пользователя в системе
— — Примечание string (255) Примечание пользователя

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "GROUP_TABLE_ID": 2,
                "USERS_TABLE_ID": 1,
                "LOGIN_ID": 102,
                "GROUP_ID": 1,
                "ЛогинФИО": "Sync-1 \/яяСинхронизатор\/",
                "ФИО": "Василий Николаевич Петров",
                "Логин": "стажер",
                "Основная группа": "Все пользователи",
                "Название": "Все пользователи",
                "Активный": 1,
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Группы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы групп пользователей
— — GROUP_ID integer (10) ID группы пользователя
— — Название string (50) Название группы пользователей
— — Примечание string (255) Примечание группы пользователей
— — ДляМаршрута boolean (1) Флаг возможности использования для маршрута

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 2,
                "GROUP_ID": 1,
                "Название": "Все пользователи",
                "Примечание": null,
                "ДляМаршрута": 1
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить пользовательскую группу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
group_id integer (10) Да - ID пользовательской группы

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "group_id": 7
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.users.groups.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User group deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Группы с пользователями (доступные)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Логин = 'A'",
    "orderby": "Логин ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.available.users.groups.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — LOGIN_ID integer (10) ID пользователя
— — GROUP_ID integer (10) ID группы пользователя
— — Логин string (50) Логин пользователя
— — ФИО string (255) Ф.И.О. пользователя
— — Название string (50) Название группы пользователей
— — Активный boolean (1) Флаг активности пользователя в системе
— — Сервер integer (3) Номер сервера
— — Примечание string (255) Примечание
— — Комментарий string (255) Комментарий

Пример ответа:

{
    "request_identifier": "alphapi.available.users.groups.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LOGIN_ID": 102,
                "GROUP_ID": 1,
                "Логин": "стажер",
                "ФИО": "Василий Николаевич Петров",
                "Название": "Все пользователи",
                "Активный": 1,
                "Сервер": 2,
                "Примечание": null,
                "Комментарий": "комментарий"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Группы с пользователями
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Объект = 'A'",
    "orderby": "Объект ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.recipients.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — CustomKey string (511) Составной идентификатор, уникальный в рамках данного справочника (состоит из RECIPIENT_TABLE_ID и RECIPIENT_ID)
— — RECIPIENT_TABLE_ID integer (3) ID таблицы сущности
— — RECIPIENT_ID integer (10) ID сущности
— — Источник string (50) Тип сущности (группа или пользователь)
— — Объект string (255) Описание сущности (Ф.И.О. или название группы)
— — Примечание string (255) Примечание сущности

Пример ответа:

{
    "request_identifier": "alphapi.recipients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1023",
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 1064,
                "Источник": "Пользователь",
                "Объект": "Василий Николаевич Петров",
                "Примечание": "стажер"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Роли
Роли с пользователями (расширенные)
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Роль = 'A'",
    "orderby": "Роль ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.roles.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы ролей пользователей
— — ROLE_ID integer (10) ID роли пользователя
— — LOGIN_ID integer (10) ID пользователя
— — Роль string (255) Роль, в которую входит пользователь
— — Логин string (255) Логин пользователя

Пример ответа:

{
    "request_identifier": "alphapi.users.roles.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 9,
                "ROLE_ID": 1,
                "LOGIN_ID": 102,
                "Роль": "Все пользователи",
                "Логин": "стажер"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Роли
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Роль = 'A'",
    "orderby": "Роль ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.roles.tbl.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы ролей
— — ROLE_ID integer (10) ID роли
— — Роль string (255) Роль
— — Примечание string (50) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.users.roles.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 9,
                "ROLE_ID": 1,
                "Роль": "Все пользователи",
                "Примечание": "примечание"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Избранное
Адресная книга пользователя
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Раздел = 'A'",
    "orderby": "Раздел ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.addressbook.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — CONTACT_ID integer (10) ID контакта
— — PARENT_TABLE_ID integer (3) ID таблицы родителя
— — PARENT_ID integer (10) ID родителя
— — Тип string (255) Тип контакта
— — Раздел string (255) Раздел источника
— — Объект string (4000) Объект источника
— — ФИО string (255) ФИО
— — Адрес string (255) Адрес
— — Контакт string (255) Контакт
— — Должность string (255) Должность
— — ДР date (Y-m-d) Дата рождения
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.addressbook.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CONTACT_ID": 101,
                "PARENT_TABLE_ID": 56,
                "PARENT_ID": 102,
                "Тип": "Почта",
                "Раздел": "Адресная книга",
                "Объект": "Иванов И.И.",
                "ФИО": "Иванов И.И.",
                "Адрес": "user@example.org",
                "Контакт": "user@example.org",
                "Должность": "Специалист",
                "ДР": null,
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать избранное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID избранного
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID избранного)
name string (255) Да - Название
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 15,
    "parents": "#101##102#",
    "name": "Изб.1",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorite.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID избранного

Пример ответа:

{
    "request_identifier": "alphapi.favorite.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite edited successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить избранное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parents string (255) - Строка ID родителей экранированных # (последний код всегда равен ID избранного)
parent_table_id integer (10) Да - ID таблицы сущности
parent_id integer (10) Да - ID сущности
name string (255) Да - Название
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "parent_table_id": 101,
    "parent_id": 101,
    "name": "Изб.1",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorite.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID избранного

Пример ответа:

{
    "request_identifier": "alphapi.favorite.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite added successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Установить мою цветовую метку
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
PARENT_TABLE_ID integer (10) Да - ID таблицы сущности
PARENT_ID integer (10) Да - ID сущности
Цвет integer (10) Да - Код цвета документа в десятичной кодировке

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "PARENT_TABLE_ID": 101,
    "PARENT_ID": 101,
    "Цвет": 16711680
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorite.my.color.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.favorite.my.color.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My color mark set successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Сбросить мою цветовую метку
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
PARENT_TABLE_ID integer (10) Да - ID таблицы сущности
PARENT_ID integer (10) Да - ID сущности

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "PARENT_TABLE_ID": 101,
    "PARENT_ID": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorite.my.color.unset Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.favorite.my.color.unset",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "My color mark unset successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить избранное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID избранного

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 777
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorite.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.favorite.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Избранное кратко
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorites.short.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — FAV_ID integer (10) ID избранного
— — PARENTS string (255) Строка вида #ID1##ID2#, которая указывает на родительскую папку в избранном
— — PARENT_TABLE_ID integer (10) ID таблицы сущности
— — PARENT_ID integer (10) ID Сущности
— — Название string (255) Название избранного
— — Примечание string (255) Примечание избранного
— — OWNER_ID integer (10) ID Пользователя владельца избранного

Пример ответа:

{
    "request_identifier": "alphapi.favorites.short.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 123,
                "PARENTS": "#55##48#",
                "PARENT_TABLE_ID": 6,
                "PARENT_ID": 2,
                "Название": "избранное 1",
                "Примечание": "Текст примечания",
                "OWNER_ID": 34
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Избранные модули
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorites.modules.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — FAV_ID integer (5) ID избранного
— — Название string (255) Название
— — ИндексИконки integer (10) Индекс иконки
— — ИндексМодуля integer (10) Индекс модуля
— — НазваниеМодуля string (255) Название модуля
— — Фильтр string (255) Фильтр

Пример ответа:

{
    "request_identifier": "alphapi.favorites.modules.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 55,
                "Название": "Изб.1",
                "ИндексИконки": 2,
                "ИндексМодуля": 12,
                "НазваниеМодуля": "Приборка",
                "Фильтр": "([Тип] LIKE '%Поручение%')"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1000 Название модуля с ID %u не найдено
Избранное
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favorites.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — FAV_ID integer (10) ID избранного
— — PARENTS string (255) Строка ID объектов родителей, экранированных # (последний код всегда равен ID избранного)
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — Название string (255) Название
— — След string (2048) Информационная строка для отображения подчиненности
— — Номер integer (10) Внутренний номер избранного
— — Тип string (255) Тип избранного
— — Описание string (4000) Описание
— — GPARENT_TABLE_ID integer (3) ID таблицы сущности
— — GPARENT_ID integer (10) ID сущности
— — Примечание string (255) Примечание
— — OWNER_ID integer (10) ID владельца

Пример ответа:

{
    "request_identifier": "alphapi.favorites.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 68,
                "FAV_ID": 2,
                "PARENTS": "#2#",
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 102,
                "Название": "изб235489",
                "След": null,
                "Номер": 102,
                "Тип": "Документ",
                "Описание": "test",
                "GPARENT_TABLE_ID": 55,
                "GPARENT_ID": 101150,
                "Примечание": "коммент",
                "OWNER_ID": 102
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Приборка
Получить статистику
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.statistic.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей при count_only и offset = 0
— items Показатели статистики (пустой массив при count_only)
— — Документов integer (10) Общее количество документов
— — Поручений integer (10) Общее количество поручений
— — Файлов integer (10) Общее количество файлов
— — Резолюций integer (10) Общее количество резолюций
— — Репликация string (12) Состояние репликации

Пример ответа:

{
    "request_identifier": "alphapi.statistic.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": {
            "Документов": 1199,
            "Поручений": 479,
            "Файлов": 253,
            "Резолюций": 187,
            "Репликация": "Не настроена"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить все мои приборы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.delall Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.delall",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактирование прибора
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dbs_id integer (10) Да - ID прибора
name string (50) - Название
columns string (1024) - Поля
model string (1024) - Шаблон
params string (1024) - Параметры
location string (255) - Положение
source string (4000) - Источник
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "dbs_id": 213,
    "name": "Прибор 1",
    "columns": "",
    "model": "",
    "params": "",
    "location": "",
    "source": "",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— dbs_id integer (10) ID прибора

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard edited successfully",
    "data": {
        "dbs_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать страницу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID страницы
name string (255) Да - Название страницы
dbs_ids integer[] Да - Массив ID приборов

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 15,
    "name": "Изб.1",
    "dbs_ids": [
        23,
        65
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID страницы

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Page edited successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Страницы с ID %u не найдена
Добавить страницу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
name string (255) Да - Название

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "name": "Страница первая"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID страницы

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Page added successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Страницы приборки
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — FAV_ID integer (10) ID страницы
— — Название string (255) Название страницы
— — DBS_IDS integer[] Массив ID приборов страницы

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 123,
                "Название": "Первая",
                "DBS_IDS": [
                    15,
                    34
                ]
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить страницу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID страницы

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 777
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить приборки на страницу
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID страницы
dbs_ids integer[] Да - Массив ID приборов

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 15,
    "dbs_ids": [
        23,
        65
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.dashboards.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID страницы

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.dashboards.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboards into page added successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Страницы с ID %u не найдена
Удалить приборки со страницы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
fav_id integer (10) Да - ID страницы
dbs_ids integer[] Да - Массив ID приборов

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 15,
    "dbs_ids": [
        23,
        65
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.pages.dashboards.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— fav_id integer (10) ID страницы

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.pages.dashboards.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboards from pages deleted successfully",
    "data": {
        "fav_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
111 Некорректный целочисленный массив обязательного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
1001 Страницы с ID %u не найдена
Установка режима сохранения значений прибора
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
mode integer (10) Да - Режим сохранения значений прибора (0 - Не сохранять, 1 - Сохранять не реже чем раз в час, 2 - Сохранять не реже чем раз в 3 часа, 3 - Сохранять не реже чем раз в 6 часов, 4 - Сохранять не реже раза в день)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "mode": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.historymode.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.historymode.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard history set mode saved successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактирование позиции прибора
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dbs_id integer (10) Да - ID прибора
position string (255) Да - Позиция
params string (1024) - Параметры

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "dbs_id": 213,
    "position": "Прибор 1",
    "params": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.position.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— dbs_id integer (10) ID прибора

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.position.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard position edited successfully",
    "data": {
        "dbs_id": 213
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Сохраненная история приборов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "DBS_ID = 'A'",
    "orderby": "DBS_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.history.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — DBS_ID integer (10) ID прибора
— — Дата время datetime (Y-m-d H:i:s) Дата и время
— — Текст text Текст

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.history.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DBS_ID": 101,
                "Дата время": "2024-04-13 01:03:03",
                "Текст": "текст"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавление прибора
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
name string (50) Да - Название
columns string (1024) - Поля
model string (1024) - Шаблон
params string (1024) - Параметры
location string (255) - Положение
source string (4000) - Источник
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "name": "Прибор 1",
    "columns": "",
    "model": "",
    "params": "",
    "location": "",
    "source": "",
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— dbs_id integer (10) ID прибора

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard added successfully",
    "data": {
        "dbs_id": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Приборы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (5) ID таблицы
— — DBS_ID integer (10) ID прибора
— — Название string (50) Название прибора
— — Поля string (1024) Настройка полей прибора для стандартных шаблонов
— — Шаблон string (1024) Шаблон прибора
— — Параметры string (1024) Параметры прибора
— — Положение string (255) Положение прибора
— — Источник string (4000) SQL запрос прибора
— — Сохранено datetime (Y-m-d H:i:s) Дата создания прибора
— — Примечание string (255) Примечание прибора

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DBS_ID": 101,
                "Название": "Отчет 1",
                "Поля": "поля",
                "Шаблон": "шаблон",
                "Параметры": "параметры",
                "Положение": "положение",
                "Источник": "select * from table",
                "Сохранено": "2021-01-01 01:01:01",
                "Примечание": "пробный отчет"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удаление прибора
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
dbs_id integer (10) Да - ID прибора

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "dbs_id": 2323
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard deleted successfully"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Счетчик моих приборов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboard.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer (10) Количество приборов

Пример ответа:

{
    "request_identifier": "alphapi.dashboard.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 5
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Типы распечаток
URL:
Эмулятор
Добавить распечатку
URL:
Эмулятор
Приборы и страницы
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "FAV_ID = 'A'",
    "orderby": "FAV_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.dashboards.pages.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — FAV_ID integer (10) ID избранного
— — DBS_ID integer (10) ID прибора
— — Название string (255) Название

Пример ответа:

{
    "request_identifier": "alphapi.dashboards.pages.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 15,
                "DBS_ID": 101,
                "Название": "первая"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Распечатки
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Тип = 'A'",
    "orderby": "Тип ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.prints.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — PRINT_ID integer (10) ID распечатки
— — Номер integer (10) Номер распечатки
— — Тип string (50) Тип распечатки
— — Описание string (255) Описание распечатки
— — Дата date (Y-m-d H:i:s) Дата распечатки
— — Пользователь string (255) Пользователь, создавший распечатку
— — Примечание string (255) Комментарий к распечатке

Пример ответа:

{
    "request_identifier": "alphapi.prints.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 46,
                "PRINT_ID": 1,
                "Номер": 1,
                "Тип": "Нестандартный",
                "Описание": "Прибор \"Мои поручения\"",
                "Дата": "2024-07-24 19:12:20",
                "Пользователь": "Разработчик",
                "Примечание": null
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Скрипты
Действия
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "Действие = 'A'",
    "orderby": "Действие ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.actions.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — ACTION_ID integer (10) ID действия
— — SM_ID integer (10) ID модели скрипта
— — Действие string (255) Действие
— — Параметры string (255) Параметры
— — Скрипт string (1024) Скрипт
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.actions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ACTION_ID": 8,
                "SM_ID": 108,
                "Действие": "Изменить проект",
                "Параметры": "{Проект}",
                "Скрипт": "EXEC dbo.SetDocProject @DOC_ID, {Проект}",
                "Примечание": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активировать скрипт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
script_id integer (10) Да - ID скрипта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "script_id": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Скрипты полный текст
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "SCRIPT_ID = 'A'",
    "orderby": "SCRIPT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.ntext.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — SCRIPT_ID integer (10) ID скрипта
— — SM_ID integer (10) ID модели скрипта
— — ACTION_ID integer (10) ID действия
— — EXT_CONDITIONS string (255) Дополнительные условия
— — Активно boolean (1) Флаг активности
— — Модель string (255) Модель скрипта
— — Название string (255) Название скрипта
— — Условия string (255) Условия выполнения
— — Действие string (255) Название действия
— — Действие скрипт string (1024) SQL/скрипт действия
— — Входные параметры string (255) Параметры действия
— — Параметры string (255) Параметры скрипта
— — Создан date (Y-m-d H:i:s) Дата создания
— — Примечание string (255) Примечание
— — Скрипт text Полный текст скрипта

Пример ответа:

{
    "request_identifier": "alphapi.scripts.ntext.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 42,
                "SCRIPT_ID": 101,
                "SM_ID": 1,
                "ACTION_ID": 2,
                "EXT_CONDITIONS": "",
                "Активно": 1,
                "Модель": "Документ",
                "Название": "Автотестовый скрипт",
                "Условия": "",
                "Действие": "Восстановление данных об исполнении",
                "Действие скрипт": "EXEC dbo.UpdateDocProgress @DOC_ID",
                "Входные параметры": "",
                "Параметры": "",
                "Создан": "2026-01-01 00:00:00",
                "Примечание": "autotest",
                "Скрипт": "DECLARE @DOC_ID INT;"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Редактировать скрипт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
script_id integer (10) Да - ID скрипта
sm_id integer (10) Да - ID модели скрипта
ext_conditions string (255) - Дополнительные условия
action_id integer (10) Да - ID действия
name string (255) Да - Название скрипта
condvalues string (255) - Параметры условий
params string (255) - Параметры действия
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "script_id": 1,
    "sm_id": 108,
    "ext_conditions": "[Контролер]='{Пользователь}'",
    "action_id": 8,
    "name": "Автотестовый скрипт",
    "condvalues": "{Проект}",
    "params": "{Проект}",
    "comment": "Описание скрипта"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— script_id integer (10) ID скрипта

Пример ответа:

{
    "request_identifier": "alphapi.scripts.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Script edited successfully.",
    "data": {
        "script_id": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Активировать все скрипты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sm_id integer (10) Да - ID модели скрипта
script_id integer (10) 0 Технический параметр (по умолчанию 0)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "sm_id": 108
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.all.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.all.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать все скрипты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sm_id integer (10) Да - ID модели скрипта
script_id integer (10) 0 Технический параметр (по умолчанию 0)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "sm_id": 108
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.all.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.all.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить скрипт по названию
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
name string (255) Да - Название скрипта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "name": "Автотестовый скрипт"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.del.byname Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.del.byname",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Деактивировать скрипт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
script_id integer (10) Да - ID скрипта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "script_id": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Добавить скрипт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
sm_id integer (10) Да - ID модели скрипта
ext_conditions string (255) - Дополнительные условия
action_id integer (10) Да - ID действия
name string (255) Да - Название скрипта
condvalues string (255) - Параметры условий
params string (255) - Параметры действия
comment string (255) - Примечание

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "sm_id": 108,
    "ext_conditions": "[Контролер]='{Пользователь}'",
    "action_id": 8,
    "name": "Автотестовый скрипт",
    "condvalues": "{Проект}",
    "params": "{Проект}",
    "comment": "Описание скрипта"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— script_id integer (10) ID скрипта

Пример ответа:

{
    "request_identifier": "alphapi.scripts.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Script added successfully.",
    "data": {
        "script_id": 1
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Скрипты
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "SCRIPT_ID = 'A'",
    "orderby": "SCRIPT_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — SCRIPT_ID integer (10) ID скрипта
— — SM_ID integer (10) ID модели скрипта
— — ACTION_ID integer (10) ID действия
— — EXT_CONDITIONS string (255) Дополнительные условия
— — Активно boolean (1) Флаг активности
— — Модель string (255) Модель скрипта
— — Название string (255) Название скрипта
— — Условия string (255) Условия выполнения
— — Действие string (255) Название действия
— — Действие скрипт string (1024) SQL/скрипт действия
— — Входные параметры string (255) Параметры действия
— — Параметры string (255) Параметры скрипта
— — Создан date (Y-m-d H:i:s) Дата создания
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.scripts.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 42,
                "SCRIPT_ID": 101,
                "SM_ID": 1,
                "ACTION_ID": 2,
                "EXT_CONDITIONS": "",
                "Активно": 1,
                "Модель": "Документ",
                "Название": "Автотестовый скрипт",
                "Условия": "",
                "Действие": "Восстановление данных об исполнении",
                "Действие скрипт": "EXEC dbo.UpdateDocProgress @DOC_ID",
                "Входные параметры": "",
                "Параметры": "",
                "Создан": "2026-01-01 00:00:00",
                "Примечание": "autotest"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Проверить уникальность названия скрипта
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
name string (255) Да - Название скрипта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "name": "Автотестовый скрипт"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.check.name Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— result boolean Результат проверки (1 - занято, 0 - свободно)

Пример ответа:

{
    "request_identifier": "alphapi.scripts.check.name",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Result is 1",
    "data": {
        "items": {
            "result": 1
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Удалить скрипт
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
script_id integer (10) Да - ID скрипта

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "script_id": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.scripts.del Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.scripts.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Script deleted successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Условия
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "C_ID = 'A'",
    "orderby": "C_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.conditions.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — C_ID integer (10) ID условия
— — SM_ID integer (10) ID модели скрипта
— — Условие string (255) Условие
— — Параметр string (255) Параметр
— — Скрипт string (1024) Скрипт
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.conditions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "C_ID": 8,
                "SM_ID": 108,
                "Условие": "Контролер равен",
                "Параметр": "{Проект}",
                "Скрипт": "[Контролер]='{Пользователь}'",
                "Примечание": ""
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
Модели скриптов
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
where text - Условие к BASE: сравнения, LIKE, IN, IS NULL, AND, OR
orderby string (2048) - Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean - Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "SM_ID = 'A'",
    "orderby": "SM_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.script.models.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit" (только при offset = 0)
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — SM_ID integer (10) ID модели скрипта
— — Название string (255) Название модели
— — Скрипт text (65535) Скрипт
— — Примечание string (255) Примечание

Пример ответа:

{
    "request_identifier": "alphapi.script.models.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 64,
                "SM_ID": 3,
                "Название": "Проверка исполнителя",
                "Скрипт": "SELECT 1;",
                "Примечание": "Пример модели"
            }
        ]
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
132 Поле "%s" имеет ограничение на максимальную длину %u
133 Поле "%s" должно иметь тип "%s", а передан тип "%s"
401 Токен неизвестен, либо его срок действия истек.
AI
AI. Краткое содержание файла
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
file_id integer Да - ID файла
min_length integer 0 Минимальная длина краткого содержания (от 0 до 1000)
max_length integer 1000 Максимальная длина краткого содержания (от 0 до 1000)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 101,
    "min_length": 50,
    "max_length": 1000
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.ai.summarize.file.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— summary text Краткое содержание файла

Пример ответа:

{
    "request_identifier": "alphapi.ai.summarize.file.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "summary": "Краткое содержание файла указанной длины"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
119 Не определена переменная окружения "%s"
125 Не определен идентификатор организации. Авторизуйтесь через /auth/org/ метод
128 Для указанного идентификатора организации "%s" не настроен адрес публичного хранилища. Обратитесь к системному администратору alphadoc
401 Токен неизвестен, либо его срок действия истек.
1001 Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002 Файл с ID "%u" не найден
AI. Парсинг постановки задачи
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
text text Да - Текст для построения директивы

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "text": "Подготовить проект договора, ответственным назначить Иванова Ивана Ивановича, срок 07.03.2026"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.ai.build.directive.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— type text Тип: Поручение|Уведомление|Согласование
— responsible text ??? ФИО сотрудника
— description text Краткое описание (до 100 символов)
— deadline text Срок: dd.mm.YYYY или число рабочих дней

Пример ответа:

{
    "request_identifier": "alphapi.ai.build.directive.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "type": "Поручение",
        "responsible": "Иванов Иван Иванович",
        "description": "Подготовить проект договора",
        "deadline": "07.03.2026"
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Frontend
Блокировка сущности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer Да - Идентификатор сущности
expiration_in_seconds integer 600 Продолжительность блокировки в секундах

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 12345,
    "expiration_in_seconds": 60
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.frontend.entity.lock.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.frontend.entity.lock.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Entity lock set successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Разблокировка сущности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer Да - Идентификатор сущности

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 12345
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.frontend.entity.lock.unset Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса

Пример ответа:

{
    "request_identifier": "alphapi.frontend.entity.lock.unset",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Entity unlock set successfully."
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Получение блокировки сущности
URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да - Ключ запроса API, полученный при авторизации
parent_table_id integer Да - ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id integer Да - Идентификатор сущности

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 12345
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.frontend.entity.lock.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) Сообщение успешности запроса
data Данные
— locked boolean Признак блокировки
— lock_info Описание блокировки
— — user_fio string (255) ФИО Пользователя, заблокировавшего сущность
— — locked_date_from datetime Дата начала блокировки
— — locked_date_to datetime Дата окончания блокировки

Пример ответа:

{
    "request_identifier": "alphapi.frontend.entity.lock.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Entity lock get successfully",
    "data": {
        "locked": true,
        "lock_info": {
            "user_fio": "Иванов И.И.",
            "locked_date_from": "2025-01-01 00:00:00",
            "locked_date_to": "2025-01-01 00:05:00"
        }
    }
}
Описание
Код Сообщение Описание
HTTP-статусы
200 Запрос обработан. Возможны как успешный ответ, так и ошибка API. Проверяйте error, error_code и success в JSON. Отсутствие обязательных параметров и неверный токен также возвращаются с HTTP 200.
400 Некорректный JSON. Ошибка разбора тела запроса: error_code = 101, error_message = JSON parsing error. Поле request_identifier отсутствует.
403 Токен не передан. Если поле token отсутствует или равно null, ответ имеет пустое тело. При token = "" возвращается JSON с error_code = 102 и HTTP 200.
404 Метод не найден. При обращении по несуществующему URL метода возвращается HTML-страница, а не JSON с кодом ошибки API.
Коды ошибок API (поле error_code)
Коды от 1000 относятся к конкретному методу и могут иметь разный смысл в разных методах. Сообщение исключения возвращается в формате «Ошибка N: сообщение»; параметры шаблонов %s и %u подставляются при выполнении запроса.
100 Превышен лимит запросов.
101 Некорректный запрос.
102 Токен не получен.
104 Неизвестная БД.
105 Не удалось подключиться к БД.
106 Ошибка БД: [%s] %s
109 Не получено обязательное поле "%s"
110 Некорректное значение обязательного целочисленного поля "%s"
115 Некорректный PID
116 Превышен лимит подключений
117 Превышен лимит запросов к методу "%s"
401 Токен неизвестен, либо его срок действия истек.
Есть вопросы? E-mail технической поддержки: info@alpha-doc.ru