АЛЬФА ДОК API

Описание API v1.1.376 от 23.06.2025 09:20

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

Авторизация

URL:

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

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

{
    "user_login": "test@example.com",
    "user_password": "P@ssw0rd",
    "db_type": "postgresql",
    "db_server": "192.168.0.10",
    "db_port": 5432,
    "db_name": "example_db"
}

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

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

{
    "request_identifier": "alphapi.auth",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Некорректный порт БД.
1001	Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%s^&*()\\_
1002	IP адреса "%s" нет в белом списке
1003	База данных не распознана.
1004	Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота.
1005	Лицензия не найдена.
1006	Серийный номер некорректен.
1007	Превышено кол-во активных пользователей в лицензии.
1008	Пользователь не активирован.
1009	Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору.

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

URL:

Эмулятор

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

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

{
    "user_login": "test@example.com",
    "user_password": "P@ssw0rd",
    "org_ident": "firma"
}

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

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

{
    "request_identifier": "alphapi.auth.org",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "db_type": "mssql",
    "storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
126	Неизвестный идентификатор организации "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Некорректный порт БД.
1001	Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%s^&*()\\_
1002	IP адреса "%s" нет в белом списке
1003	База данных не распознана.
1004	Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота.
1005	Лицензия не найдена.
1006	Серийный номер некорректен.
1007	Превышено кол-во активных пользователей в лицензии.
1008	Пользователь не активирован.
1009	Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

{
    "request_identifier": "alphapi.logout",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Обновить токен

URL:

Эмулятор

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

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

{
    "refresh_token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d"
}

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

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

{
    "request_identifier": "alphapi.auth.refresh",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "ip": "145.123.53.25",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Ошибка обновления токена

Справочники

Автозамены

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — FAV_ID	integer (10)		ID замены
— — Слово	string (255)		Слово
— — Замена	string (255)		Замена

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

{
    "request_identifier": "alphapi.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Адреса пользователей

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Активные пользователи

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LOGIN_ID	integer (10)		ID пользователя
— — EXT_GROUPS	string (255)		Список ID групп пользователя, в которых он состоит (экранированный #)
— — Активный	boolean (1)		Флаг: активен ли пользователь в системе
— — Логин	string (255)		Логин пользователя
— — Основная группа	string (50)		Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — ФИО	string (255)		Ф.И.О. пользователя
— — Должность	string (255)		Должность пользователя (данная строка не коллериуется с разделом системы "должности")
— — Примечание	string (255)		Примечание пользователя
— — ЛогинФИО	string (564)		Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — Сервер	integer (3)		Номер сервера АЛЬФА ДОК, где был создан логин

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

{
    "request_identifier": "alphapi.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Активные типы документов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — ROW_ID	integer (10)		ID записи
— — DT_ID	integer (10)		ID типа документа
— — Нумерация	integer (3)		Нумерация
— — Шаблон	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,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Активные типы ссылок

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.link.types.active.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (5)		ID таблицы
— — LT_ID	integer (10)		ID типа ссылки
— — Активен	boolean (1)		Флаг активности
— — Название	string (50)		Название типа ссылки
— — Расшифровка	string (255)		Расшифровка типа ссылки
— — Доступен	integer[]		Строка ID объектов сущностей для которых применим тип ссылки
— — Примечание	string (255)		Примечание типа ссылки

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

{
    "request_identifier": "alphapi.link.types.active.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LT_ID": 101,
                "Активен": true,
                "Название": "Основной тип",
                "Расшифровка": "пояснение",
                "Доступен": [
                    101,
                    55
                ],
                "Примечание": "примечание"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Аудит должностей

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Банки

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Все типы документов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — ROW_ID	integer (10)		ID записи
— — DT_ID	integer (10)		ID типа документа
— — Нумерация	integer (3)		Нумерация
— — Шаблон	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,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "Цвет": 13434,
                "БлокЦвета": 1,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить банк

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
bank_name	string (255)	Да	-	Название банка
bik	string (9)	Да	-	Банковский идентификационный код
kc	string (20)	Да	-	Корреспондентский счет
comment	string (255)		-	Примечание

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

{
    "bank_name": "Тинькофф",
    "bik": "123456789",
    "kc": "12345678901234567890",
    "comment": "комментарий"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.banks.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 сущности
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)	Да	-	Значение параметра

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 101,
    "number": 1,
    "value": "Значение"
}

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Mask param value added successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Тип документа с ID "%s" не найден
1001	Маска(mask) документа пуста
1002	Номер(number) параметра не найден в маске
1003	Ошибка определения значения(value) параметра в маске
1004	Значение(value) параметра больше разрешенной длины в маске

Добавить контакт

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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_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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить правовую форму

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
legal_form_name	string (50)	Да	-	Название правовой формы
legal_form_name_full	string (255)	Да	-	Полное название правовой формы
comment	string (255)		-	Примечание

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

{
    "legal_form_name": "ООО",
    "legal_form_name_full": "Общество с ограниченной ответственностью",
    "comment": "комментарий"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.legalforms.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (255)		-	Поле связи проекта со внешними системами
color	integer (10)		-	Цветовой тег проекта, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736
comment	string (255)		-	Комментарий

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "name": "Зеленоград",
    "enable": 1,
    "login_id": 1931,
    "planschedule": "2025-06-15",
    "key": "",
    "color": 16711680,
    "comment": "комментарий"
}

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

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

{
    "request_identifier": "alphapi.project.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project added successfully",
    "data": {
        "p_id": 5
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Должности

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — POS_ID	integer (10)		ID должности
— — PARENTS	string (255)		Строка ID объектов родителей экранированных # (последний код всегда равен ID должности)
— — Номер	integer (10)		Внутренний номер должности (равен ID должности)
— — След	string (2048)		Информационная строка для отображения подчиненности
— — Логин	string (50)		Логин пользователя, назначенного на должность
— — Сервер	integer (3)		Сервер, где была создана должность
— — Должность	string (255)		Название должности
— — ФИО	string (255)		ФИО пользователя, назначенного на должность
— — Email	string (255)		Адрес электронной почты пользователя, назначенного на должность
— — Подразделение	string (50)		Подразделение пользователя, назначенного на должность
— — Телефон	string (255)		Телефон пользователя, назначенного на должность
— — Примечание	string (255)		Примечание должности
— — Активна	boolean (1)		Флаг: активности должности
— — Создана	datetime (Y-m-d H:i:s)		Метка даты и времени создания должности

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Должности без справочников

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — POS_ID	integer (10)		ID должности
— — PARENTS	string (255)		Строка ID объектов родителей экранированных # (последний код всегда равен ID должности)
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Должности. Индекс

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (10)		ID таблицы
— — POS_ID	integer (10)		ID должности
— — Раздел	string (50)		Раздел
— — Объект	string (255)		Объект
— — Дата	datetime (Y-m-d H:i:s)		Дата
— — Индекс	string (815)		Индекс

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

{
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступ к должностям

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступ к должностям (расширенный)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступы к типам документов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Значения параметра маски

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Тип документа с ID "%s" не найден
1002	Тип документа с ID "%s" не содержит параметров
1003	Тип документа с ID "%s" не содержит параметра %u. Максимальное кол-во %u

Исполнители

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 150
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.routes.points.responsibles.directory.tbl.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — CustomKey	string (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.routes.points.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Исполнители (Расширенный)

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "CustomKey = 'A'",
    "orderby": "CustomKey ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.routes.points.responsibles.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — CustomKey	string (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.routes.points.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контакты (Расширенный)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Маски адресов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Недавние маршруты документов

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 1
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.recent.docs.routes.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Параметры типов документов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — DT_ID	integer (10)		ID типа документа
— — Активен	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,
                "Активен": 1,
                "Номер": 1,
                "Название": "Исх.номер",
                "Группа": 1,
                "Тип": "Строка",
                "Маска": "Cccccccccccccccccccc",
                "Обязательный": 1,
                "Справочник": 0,
                "Связанный": 0,
                "Длина": 20
            },
            {
                "DT_ID": 104,
                "Активен": 1,
                "Номер": 1,
                "Название": "Дата",
                "Группа": 2,
                "Тип": "Строка",
                "Маска": "<>00.00<>\\.2\\000",
                "Обязательный": 1,
                "Справочник": 0,
                "Связанный": 1,
                "Длина": 10
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Тип документа с ID "%s" не найден
1002	Тип документа с ID "%s" не содержит параметров

Пользователи

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LOGIN_ID	integer (10)		ID пользователя
— — EXT_GROUPS	string (255)		Список ID групп пользователя, в которых он состоит (экранированный #)
— — Активный	boolean (1)		Флаг: активен ли пользователь в системе
— — Логин	string (255)		Логин пользователя
— — Основная группа	string (50)		Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — ФИО	string (255)		Ф.И.О. пользователя
— — Должность	string (255)		Должность пользователя (данная строка не коллериуется с разделом системы "должности")
— — Примечание	string (255)		Примечание пользователя
— — ЛогинФИО	string (564)		Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — Сервер	integer (3)		Номер сервера АЛЬФА ДОК, где был создан логин

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Правовые формы

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.legal.forms.tbl.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — LF_ID	integer (10)		ID правовой формы
— — ПФ	string (50)		Название правовой формы
— — Расшифровка	string (255)		Полное название правовой формы
— — Примечание	string (255)		Примечание

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

{
    "request_identifier": "alphapi.legal.forms.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "LF_ID": 31,
                "ПФ": "ООО",
                "Расшифровка": "Общество с ограниченной ответственностью",
                "Примечание": "примечание"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Проекты

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

{
    "request_identifier": "alphapi.projects.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "P_ID": 101,
                "PARENTS": "#101#",
                "RESPONSIBLE_ID": 101,
                "Номер": 101,
                "След": null,
                "Название": "Название проекта",
                "Создан": "2001-01-01 01:01:01",
                "Активен": 1,
                "План-график": "2001-01-01 01:01:01",
                "Цвет": null,
                "БлокЦвета": null,
                "Примечание": "Текст примечания",
                "Ответственный": "Иванов И.И."
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Рабочий календарь без справочников

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Тип дня = 'A'",
    "orderby": "Тип дня ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.calendar.ext	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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.ext",
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Редактировать запись в календаре

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)	Да	-	Старое значение параметра

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

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 101,
    "number": 1,
    "value": "Новое значение",
    "old_value": "Старое значение"
}

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

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

{
    "request_identifier": "alphapi.doc.type.mask.param.values.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Mask param value edited successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Тип документа с ID "%s" не найден
1001	Маска(mask) документа пуста
1002	Номер(number) параметра не найден в маске
1003	Ошибка определения значения(value) параметра в маске
1004	Значение(value) параметра больше разрешенной длины в маске

Редактировать контакт

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (255)		-	Поле связи проекта со внешними системами
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Статусы документов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Статусы точек маршрута

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы адресов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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": [
            {
                "Тип": "поставщик"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы документов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — ROW_ID	integer (10)		ID записи
— — DT_ID	integer (10)		ID типа документа
— — Нумерация	integer (3)		Нумерация
— — Шаблон	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,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы контактов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы ссылок

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Название = 'A'",
    "orderby": "Название ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.link.types.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (5)		ID таблицы
— — LT_ID	integer (10)		ID типа ссылки
— — Активен	boolean (1)		Флаг активности
— — Название	string (50)		Название типа ссылки
— — Расшифровка	string (255)		Расшифровка типа ссылки
— — Доступен	integer[]		Строка ID объектов сущностей для которых применим тип ссылки
— — Разделы	string (1024)		Разделы системы для которых применим тип ссылки
— — Примечание	string (255)		Примечание типа ссылки

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

{
    "request_identifier": "alphapi.link.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LT_ID": 101,
                "Активен": true,
                "Название": "Основной тип",
                "Расшифровка": "пояснение",
                "Доступен": [
                    101,
                    55
                ],
                "Разделы": "Документы",
                "Примечание": "примечание"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.address.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.banks.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.clients.bankdetails.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.calendar.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Day deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.contact.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.contact.ext.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Extended contact deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.legalforms.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Часто используемые значения параметра маски

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.return",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as returned successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 10449,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as stoped successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.decline",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point declined successfully",
    "data": {
        "rp_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.taken",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point taken successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as viewed successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.finish",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as finished successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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)		-	Текст резолюции/комментария

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.confirm",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as confirmed successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.read",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as read successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Поручения

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — RP_ID	integer (10)		ID поручения
— — RPS_ID	integer (10)		ID статуса поручения
— — PARENTS	string (255)		Строка ID родителей экранированных # (последний код всегда равен ID точки поручения)
— — RPT_ID	integer (10)		ID типа поручения (Поручение/Уведомление/Согласование)
— — DOC_ID	integer (10)		ID документа
— — 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": [
            {
                "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Согласовать точку маршрута

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.accept",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point accepted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.commissions.count	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer (10)		Общее кол-во
— count_new	integer (10)		Кол-во новых
— count_expired	integer (10)		Кол-во просроченных
— ids	string (255)		Массив ID поручений, разделенных "&"
— ids_new	string (255)		Массив ID новых поручений, разделенных "&"

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

{
    "request_identifier": "alphapi.commissions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Counter of documents under control",
    "data": {
        "count": 123,
        "count_new": 12,
        "count_expired": 1,
        "ids": "101&102&103",
        "ids_new": "101&102&103"
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "responsible_table_id": 1,
    "responsible_id": 101
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.responsible.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point responsible set successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Цвета поручений

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — RP_ID	integer (10)		ID поручения
— — Цвет	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контроль

Документы на контроле

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — DOC_ID	integer (10)		ID документа
— — DOC_CONTROLLER_ID	integer (10)		ID контроллера документа
— — DS_ID	integer (10)		ID статуса документа
— — DT_ID	integer (10)		ID типа документа
— — Активен	boolean (1)		Флаг: активен ли докумнт или нет (документ может быть неактивным, если это черновик или на паузе)
— — Индикатор	integer (3)		Кол-во дней без изменений в документе. Если индикатор = -1, то это значит, что есть изменения требующие внимания контролера
— — Тип	string (50)		Тип документа
— — Номер	integer (10)		Внутренний номер документа (равен ID документа)
— — Дата	date (Y-m-d H:i:s)		Дата создания черновика документа
— — Статус	string (50)		Статус документа
— — Контролер	string (50)		Ф.И.О. пользователя контролера по документу
— — Регистратор	string (50)		Ф.И.О. пользователя регистратора по документу
— — Проект	string (255)		Название проекта документа
— — Содержание	string (400)		Содержание документа
— — Срок	date (Y-m-d H:i:s)		Общий срок документа (не путать со сроком поручения)
— — Регистрация	date (Y-m-d H:i:s)		Дата регистрации документа, если эта функция используется
— — Рег.номер	string (50)		Регистрационный номер документа, если эта функция используется
— — Выполнение	integer (3)		Процент выполнения маршрута документа (отношение выполненых точек маршрута к общему числу)
— — Исполнители	string (255)		ФИО текущих исполнителей по документу через запятую (до 3 человек)
— — Комментарий	string (255)		Комментарий документа
— — Содержание_MASK	string (1024)		Маска поля ввода "Содержание" (используется для форматированного ввода текста в поле содержание)
— — Новое	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,
                "DOC_CONTROLLER_ID": 1070,
                "DS_ID": 101,
                "DT_ID": 1,
                "Активен": 1,
                "Индикатор": 12,
                "Тип": "Документ",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Статус": "Выполняется",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта",
                "Содержание": "Содержание документа",
                "Срок": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "",
                "Выполнение": 33,
                "Исполнители": "Сидоров С.С.",
                "Комментарий": "Комментарий к документу",
                "Содержание_MASK": "",
                "Новое": 1
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer (10)		Общее кол-во
— count_new	integer (10)		Кол-во новых
— count_expired	integer (10)		Кол-во просроченных
— ids	string (255)		Массив ID документов, разделенных "&"
— ids_new	string (255)		Массив ID новых документов, разделенных "&"

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

{
    "request_identifier": "alphapi.control.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Counter of documents under control",
    "data": {
        "count": 123,
        "count_new": 12,
        "count_expired": 1,
        "ids": "101&102&103",
        "ids_new": "101&102&103"
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы документов на контроле

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Цвета документов на контроле

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — DOC_ID	integer (10)		ID документа
— — Цвет	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Документы

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "DOC_ID = 101",
    "orderby": "Дата время DESC",
    "limit": 1000,
    "offset": 0
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.audit.all.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
114	Переданный лимит не может быть выше %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Документы

URL:

Эмулятор

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

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

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

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Документы без справочников

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — ROW_ID	integer (10)		ID записи
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Приоритет = 'A'",
    "orderby": "Приоритет ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.links.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LINK_ID	integer (10)		ID ссылки
— — DOC_ID	integer (10)		ID документа
— — Ссылка	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.docs.links.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,
                "Тип": "Тип",
                "Номер": 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Комментарии/резолюции документов

URL:

Эмулятор

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

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

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

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

{
    "request_identifier": "alphapi.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Кросс ссылки

URL:

Эмулятор

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

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

{
    "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.crosslinks.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LINK_ID	integer (10)		ID ссылки
— — DOC_ID	integer (10)		ID документа
— — Тип	string (50)		Тип
— — Номер	integer (10)		Номер
— — Ссылка	string (50)		Ссылка
— — Пользователь	string (255)		Пользователь
— — Создана	datetime (Y-m-d H:i:s)		Создана

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

{
    "request_identifier": "alphapi.docs.crosslinks.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,
                "Ссылка": "Ссылка",
                "Пользователь": "Иванов И.И.",
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Проверить наличие документа

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
query	string (255)	Да	-	Поисковая фраза
where	string (2048)		-	Строка "WHERE" к запросу BASE
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": "альфа"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.doc.check	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

{
    "request_identifier": "alphapi.docs.progress.tbl.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "DOC_ID": 101,
                "Выполнение": 50
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "date_created": "2001-01-01",
    "before_date_created": 0
}

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

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

{
    "request_identifier": "alphapi.docs.files.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Цвета документов

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "login_id": 15
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.color.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — DOC_ID	integer (10)		ID документа
— — Цвет	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

ЭП файлов документов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — F_ID	integer (10)		ID файла
— — DOC_ID	integer (10)		ID документа
— — Номер	integer (10)		Номер
— — Файл	string (255)		Название
— — Редакция	integer (10)		Редакция
— — Пользователь	integer (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Документ

Аудит документа

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.audit.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Дерево комментариев

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.comments.parents.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — COMMENT_ID	integer (10)		ID резолюции/комментария
— — DOC_ID	integer (10)		ID документа
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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.type.mask.param.values.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.route.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route added successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Исходный документ не найден
1001	Исходный документ не содержит маршрут
1002	В массиве "routePointsResponsibles" допустимы только дни(days), либо дата окончания(end_date)
1003	Дата окончания(end_date) не может быть меньше текущей даты

Добавить ссылку

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
doc_id	integer (10)	Да	-	ID документа
parent_table_id	integer (10)	Да	-	ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id	integer (10)	Да	-	ID сущности
lt_id	integer (10)	Да	-	ID типа связи, по умолчанию 1

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 534,
    "parent_table_id": 55,
    "parent_id": 123,
    "lt_id": 1
}

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

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

{
    "request_identifier": "alphapi.doc.link.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Link added successfully",
    "data": {
        "link_id": 5
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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": 101,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.doc.type.mask.param.values.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— rp_id	integer (10)		ID точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point added successfully",
    "data": {
        "rp_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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-1024)		-	Содержание документа (длина поля зависит от БД). Обязательно для некоторых типов документов
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
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",
    "mask_params": [
        [
            "Значение первого параметра содержания",
            "Значение второго параметра содержания"
        ]
    ]
}

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

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

{
    "request_identifier": "alphapi.doc.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1002	Параметры документа не переданы
1003	Некорректный тип параметра #%s документа. Должен быть "%s"
1004	Параметр содержания #%u не соответствует маске
1005	Параметр содержания #%s содержит несуществующее значение "%s"
1006	Параметр содержания #%u превышает максимальную длину %s
1007	Параметр содержания #%u содержит некорректную дату "%s"
1008	Параметр содержания #%u после подстановки маски изменил значение. Было "%s", стало "%s"
1009	Маска, выбранная для параметра #%u, подразумевает ввод даты с 2000 по 2099 год

Документы документа

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.doc.links.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LINK_ID	integer (10)		ID ссылки
— — DOC_ID	integer (10)		ID документа
— — Ссылка	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.doc.links.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,
                "Тип": "Тип",
                "Номер": 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.access.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — CustomKey	string (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.activation.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "comment": "Комментарий"
}

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

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

{
    "request_identifier": "alphapi.doc.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document stoped successfully",
    "data": {
        "doc_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.file.move",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.mark.view	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.linked.doc.access",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Access to linked doc checked"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.views.all.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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,
                "Документ": "",
                "ДатаДокумента": "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Простые ЭП файлов документа

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

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

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

{
    "request_identifier": "alphapi.doc.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "count": 1,
    "data": {
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 101,
                "Номер": 2,
                "Файл": "Приложение.doc",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "ЭП": -4.94714764660603
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 типа документа
p_id	integer (10)	Да	-	ID проекта документа
controller_id	integer (10)	Да	-	ID пользователя контролера документа
plan_end_date	date (YYYY-MM-DD)		-	Срок документа
content	text (255-1024)		-	Содержание документа (длина поля зависит от БД). Обязательно для некоторых типов документов
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
mask_params	varchar[]		-	Массив параметров содержания документа

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

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 14,
    "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",
    "mask_params": [
        [
            "Значение первого параметра содержания",
            "Значение второго параметра содержания"
        ]
    ]
}

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

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

{
    "request_identifier": "alphapi.doc.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1002	Параметры документа не переданы
1003	Некорректный тип параметра #%s документа. Должен быть "%s"
1004	Параметр содержания #%u не соответствует маске
1005	Параметр содержания #%s содержит несуществующее значение "%s"
1006	Параметр содержания #%u превышает максимальную длину %s
1007	Параметр содержания #%u содержит некорректную дату "%s"
1008	Параметр содержания #%u после подстановки маски изменил значение. Было "%s", стало "%s"
1009	Маска, выбранная для параметра #%u, подразумевает ввод даты с 2000 по 2099 год

Редактировать точку маршрута

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": 101,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}

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

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

{
    "request_identifier": "alphapi.doc.routepoint.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point edited successfully",
    "data": {
        "rp_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Резолюции по документу

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.comments.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — COMMENT_ID	integer (10)		ID резолюции/комментария
— — 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)		Описательная часть поручения, к которой относится резолюция/комментарий

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— doc_id	integer (10)		ID документа

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

{
    "request_identifier": "alphapi.doc.controller.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Controller set successfully",
    "data": {
        "doc_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— comments_count	integer (10)		Кол-во резолюций
— files_count	integer (10)		Кол-во файлов
— links_count	integer (10)		Кол-во привязанных документов
— contractor_count	integer (10)		Кол-во контрагентов
— views_count	integer (10)		Кол-во просмотров

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

{
    "request_identifier": "alphapi.doc.counters",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Incorrect text identifier \"counter_of_documents_success\".",
    "data": {
        "comments_count": 55,
        "files_count": 12,
        "links_count": 1,
        "contractor_count": 6,
        "views_count": 5
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы документа

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
doc_id	integer	Да	10	ID документа
mode_extended	boolean		1	Выдавать массивы в ответе
where	string (2048)		-	Строка "WHERE" к запросу BASE
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,
    "mode_extended": 0
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.doc.types.ext	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — DT_ID	integer (10)		ID типа документа
— — Название	string (50)		Название
— — Маска	string (480)		Маска
— — Шаблон	string (50)		Шаблон
— — Нумерация	integer (3)		Нумерация
— — 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.ext",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DT_ID": 108,
                "Название": "Документ",
                "Маска": null,
                "Шаблон": "<!{Номер}>",
                "Нумерация": 5,
                "P_ID_default": null,
                "DOC_ID_default": null,
                "DOC_IDS": [
                    123,
                    54
                ],
                "P_IDS": [],
                "LT_IDS": []
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Удалить ссылку

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "link_id": 534
}

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

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

{
    "request_identifier": "alphapi.doc.link.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Link deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Routepoint deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.startdate.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Start date set successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

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

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Файлы подписей документа

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.files.signs.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — F_ID	integer (10)		ID файла
— — DOC_ID	integer (10)		ID документа
— — PARENT_TABLE_ID	integer (10)		ID таблицы сущности
— — PARENT_ID	integer (10)		ID сущности
— — Активен	boolean (1)		Флаг: активен ли документ или нет (документ может быть неактивным, если это черновик или на паузе)
— — НомерДокумента	integer (10)		Внутренний номер документа (равен ID документа)
— — ДатаДокумента	datetime (Y-m-d H:i:s)		Дата создания черновика документа
— — Срок	datetime (Y-m-d H:i:s)		Общий срок документа (не путать со сроком поручения)
— — Исполнен	datetime (Y-m-d H:i:s)		Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер	string (255)		Ф.И.О. пользователя контролера по документу
— — Регистратор	string (255)		Ф.И.О. пользователя регистратора по документу
— — Проект	string (255)		Название проекта документа
— — Содержание	string (255)		Содержание документа
— — Название	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Хронология

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.chrono.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты

Адреса контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Аудит контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Аудит справочников контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Банки ЦБ РФ

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
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	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — bank_name	string (255)		Название банка
— — bik	string (9)		БИК
— — kc	string (20)		Кор. счет

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

{
    "request_identifier": "alphapi.external.sbrf.banks",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "bank_name": "Сбербанк",
                "bik": "123456789",
                "kc": "12345678901234567890"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Файл не доступен на удаленном хранилище
1001	Ошибка обработки файла. Шаг %s

Банковские счета

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "ACCOUNT_ID = 1",
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Города

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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)	Да	-	Категория контрагнета, может принимать следующие значения: 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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить регион

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
region_name	string (255)	Да	-	Название
region_center	string (255)		-	Центр
tz_id	integer (1)	Да	-	ID Часового пояса
comment	string (255)		-	Примечание

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

{
    "tz_id": 1,
    "region_name": "Москва",
    "region_center": "Москва",
    "comment": "комментарий"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.regions.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить сегмент

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
segment_name	string (255)	Да	-	Название сегмента
comment	string (255)		-	Примечание

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

{
    "segment_name": "Второй",
    "comment": "комментарий"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.segments.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Документы контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LINK_ID	integer (10)		ID ссылки
— — DOC_ID	integer (10)		ID документа
— — CLIENT_ID	integer (10)		ID контрагента
— — Ссылка	string (50)		Ссылка
— — Активен	integer (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступ к контрагентам

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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)		Объект доступа
— — Родитель	integer (255)		Родитель доступа
— — Примечание	integer (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступ к контрагентам (расширенный)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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)		Пользователь
— — Родитель	integer (255)		Родитель доступа
— — Примечание	integer (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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Категории

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Комментарии контрагентов

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — COMMENT_ID	integer (10)		ID комментария
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контакты контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты (расширенный)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты без справочников

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}

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

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

{
    "request_identifier": "alphapi.clients.docs.links.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты. Дерево

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Контрагенты. Родители

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Менеджеры

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — LOGIN_ID	integer (10)		ID пользователя
— — Логин	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Проверить наличие контрагента

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
query	string (255)	Да	-	Поисковая фраза
where	string (2048)		-	Строка "WHERE" к запросу BASE
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": "альфа"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.client.check	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Регионы

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Редактировать сегмент

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Сегменты

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Справочники контрагентов. Индекс

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (10)		ID таблицы
— — CLIENT_ID	integer (10)		ID контрагента
— — Раздел	string (50)		Раздел
— — Объект	string (255)		Объект
— — Дата	datetime (Y-m-d H:i:s)		Дата
— — Индекс	string (815)		Индекс

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

{
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы контрагентов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.regions.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Region deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.segments.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Segment deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.docs.gantt.items.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы точек маршрута
— — RP_ID	integer (10)		ID точки маршрута
— — DOC_ID	integer (10)		ID документа
— — RPT_ID	integer (10)		ID типа точки маршрута (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.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 101,
                "RPS_ID": 101,
                "DOC_CONTROLLER_ID": 101,
                "LOGIN_ID": 101,
                "LINKS": "#101##102#",
                "PARENTS": "#101##102#",
                "Номер": 101,
                "Описание": "Описание точки маршрута",
                "Исполнитель": "Роль\/группа\/пользователь",
                "Документ": "Описание документа точки маршрута",
                "Статус": "Статус точки маршрута",
                "НачалоПлан": "2001-01-01 01:01:01",
                "Начало": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Выполнено": "2001-01-01 01:01:01",
                "Подтверждено": "2001-01-01 01:01:01",
                "Индикатор": 1,
                "Контролер": "Иванов И.И.",
                "Примечание": null
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Неуказанные исполнители

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
where	string (2048)		-	Строка "WHERE" к запросу BASE
orderby	string (2048)		-	Строка "ORDER BY" к запросу BASE
limit	integer (10)		0	Ограничить кол-во записей (0 - без ограничения)
offset	integer (10)		0	Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only	boolean		-	Вывод только количества строк
doc_id	integer	Да	10	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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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)		Примечание точки маршрута
— — Срок документа	boolean (1)		Срок документа
— — Редактируемый срок	boolean (1)		Редактируемый срок
— — Редактируемое описание	boolean (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,
                "Срок": "2001-01-01 01:01:01",
                "Дней": 3,
                "Описание": "Добавлен комментарий",
                "Примечание": "Добавлен комментарий",
                "Срок документа": "Да",
                "Редактируемый срок": "Нет",
                "Редактируемое описание": "Да"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Поручения по документу

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "LOGIN_ID = 1",
    "orderby": "Создана DESC",
    "limit": 1,
    "offset": 0
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.routes.points.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — RP_ID	integer (10)		ID точки маршрута
— — DOC_ID	integer (10)		ID документа
— — RESPONSIBLE_TABLE_ID	integer (3)		ID таблицы сущности исполнителя (пользователь/должность/группа)
— — RESPONSIBLE_ID	integer (10)		ID сущности исполнителя (пользователь/должность/группа)
— — LOGIN_ID	integer (10)		ID пользователя исполнителя поручения
— — RPT_ID	integer (10)		ID типа точки маршрута (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.routes.points.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Стандартные маршруты

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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.docs.gantt.items.directory.tbl.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы точек маршрута
— — RP_ID	integer (10)		ID точки маршрута
— — DOC_ID	integer (10)		ID документа
— — RPT_ID	integer (10)		ID типа точки маршрута (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": {
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 101,
                "RPS_ID": 101,
                "DOC_CONTROLLER_ID": 101,
                "LOGIN_ID": 101,
                "LINKS": "#101##102#",
                "PARENTS": "#101##102#",
                "PARENT_ID": 101,
                "Номер": 101,
                "Статус": "Статус точки маршрута",
                "Документ": "Описание документа точки маршрута",
                "Описание": "Описание точки маршрута",
                "Исполнитель": "Роль\/группа\/пользователь",
                "Контролер": "Иванов И.И.",
                "ПолеПоиска": "Поле поиска",
                "Примечание": null,
                "Expr1": null
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Точки маршрута документа

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "LOGIN_ID = 1",
    "orderby": "Создана DESC",
    "limit": 1,
    "offset": 0
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.routes.points.directory.tbl.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — RP_ID	integer (10)		ID точки маршрута
— — 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.routes.points.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Шаблоны файлов маршрутов

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_ids": [
        101,
        102,
        103
    ]
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.routes.files.templates.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — F_ID	integer (10)		ID файла
— — DOC_ID	integer (10)		ID документа
— — Название маршрута	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить комментарий

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "comment": "Тест"
}

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

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

{
    "request_identifier": "alphapi.system.comment.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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)		-	Примечание

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Тип подписи неизвестен
1002	Входящий массив пуст
1003	Файлы с ID [%s] не найдены

Добавить подпись (множественную)

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Тип подписи неизвестен
1002	Входящий массив пуст
1003	Файлы с ID [%s] не найдены

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "file_ids": [
        101,
        777
    ]
}

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

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

{
    "request_identifier": "alphapi.system.file.addview",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить файл

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— file_id	integer		ID файла

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

{
    "request_identifier": "alphapi.system.file.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parent_table_id	integer (3)	Да	-	ID таблицы сущности
parent_id	integer (10)	Да	-	ID сущности
file_name	string	Да	-	Имя файла
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— file_id	integer		ID файла

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

{
    "request_identifier": "alphapi.system.file.add.with.edits",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Невалидный svg-файл
1002	Ошибка преобразования в pdf: "%s"
1003	Ошибка добавления файла с правками: "%s"
1004	Файл не найден: "%s"
1005	Файл не сохранен: "%s"
1006	Ошибка Imagick: "%s"

Добавить файл с содержимым

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— file_id	integer		ID файла

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

{
    "request_identifier": "alphapi.system.file.add.with.content",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "file_id": 12448
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Ошибка декодирования алгоритма Base64

Доступные элементы GUI

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Доступные элементы интерфейса

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Описание = 'A'",
    "orderby": "Описание ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

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

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

{
    "request_identifier": "alphapi.system.interface.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.count	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Комментарии комментариев

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "comment_id": 134
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.comments.comments.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — COMMENT_ID	integer (10)		ID комментария
— — PARENT_TABLE_ID	integer (3)		ID таблицы сущности
— — PARENT_ID	integer (10)		ID сущности
— — Дата время	datetime (Y-m-d H:i:s)		Дата и время комментария
— — Текст	string (2048)		Текст комментария
— — Пользователь	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",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С."
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Комментарии. Индекс

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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 (815)		Индекс

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

{
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Конфигурация для редактирования файлов в 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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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)		Тема оформления
— — — 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"
                }
            },
            "token": "config-jwt-token"
        }
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002	Файл с ID "%u" не найден
1100	Переданный параметр "file_prev_key" не валидный по длине. Ожидается 32 символа a-z0-9

Конфигурация для сравнения двух файлов в 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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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)		Тема оформления
— — — 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"
                }
            },
            "token": "config-jwt-token",
            "document_compare": {
                "fileType": "doc",
                "title": "сайт_сравнение.doc",
                "url": "https:\/\/storage04.alpha-doc.ru\/web\/115B3999768BBE3C6A14B3528E394311.doc"
            }
        }
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Лицензии

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "file_hash": "0A4BB28F7C07FAA3424DF3342DAABBA1184"
}

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

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

{
    "request_identifier": "alphapi.system.file.meta.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "count_pages": 7
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Файл с мета данными "%s" не найден
1002	Ошибка считывания файла с мета данными

Номер текущего сервера

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Параметры маски

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — number	integer		Номер параметра
— — value	text (255)		Значение параметра

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

{
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Маска "%s" не содержит параметров

Параметры масок

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — mask	string		Указанная маска
— — params			Массив элементов
— — — number	integer		Номер параметра
— — — value	text (255)		Значение параметра

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

{
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Маска "%s" не содержит параметров
2000	Маска "%s" не содержит параметра с номером "%s"

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "file_id": 101
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.system.file.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Файл "%s" не найден в хранилище. Вызовите метод /system/file/addview/
1002	Файл с ID "%u" не найден

Получить название компании лицензиата

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.licenses.getcompanyname	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Получить следующую редакцию файла

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.set.read",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.set.unread",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.set.massunread",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

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

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

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

{
    "request_identifier": "alphapi.system.file.markascopied",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — DAY_ID	integer (10)		ID дня
— — DT_ID	integer (10)		Тип дня
— — Дата	date (Y-m-d H:i:s)		Дата
— — Примечание	string (255)		Примечание

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

{
    "request_identifier": "alphapi.calendar.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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count_days	integer (10)		Кол-во рабочих дней

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

{
    "request_identifier": "alphapi.system.workdaysdiff",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count_days": 11
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — date_start	date (Y-m-d)		Дата начала
— — date_end	date (Y-m-d)		Конечная дата
— — count_days	integer (10)		Кол-во рабочих дней

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

{
    "request_identifier": "alphapi.system.workdaysdiff.multiple",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "date_start": "2021-01-15",
                "date_end": "2021-01-30",
                "count_days": 11
            },
            {
                "date_start": "2021-02-01",
                "date_end": "2021-02-13",
                "count_days": 10
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1000	Входящий массив дат пуст.
1001	Входящий массив дат некорректен.
1002	Даты должны быть в формате "YYYY-MM-DD"

Редактировать комментарий

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "comment_id": 213,
    "comment": "Комментарий"
}

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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)		-	Примечание

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.check	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "count_day": 3
}

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

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

{
    "request_identifier": "alphapi.system.get.deadline",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "date": "01.01.2001"
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.autosign.status	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Типы дней для производственного календаря

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.file.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "File deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Удалить комментарий

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.comment.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Comment deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.licenses.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "License deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Файлы текущего пользователя

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — F_ID	integer (10)		ID файла
— — Название	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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Элементы GUI

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— login_id	integer (10)		ID пользователя

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

{
    "request_identifier": "alphapi.user.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "login_id": 101
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.user.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.user.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Роли текущего пользователя

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Файлы пользователей

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы
— — F_ID	integer (10)		ID файла
— — 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Пользовательские группы

Группы

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Группы с пользователями

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — CustomKey	string (511)		Составной идентификатор, уникальный в рамках данного справочника (состоит из RECIPIENT_TABLE_ID и RECIPIENT_ID)
— — RECIPIENT_TABLE_ID	integer (3)		ID таблицы сущности
— — RECIPIENT_ID	integer (10)		ID сущности
— — Источник	string (50)		Тип сущности (группа или пользователь)
— — Объект	string (255)		Описание сущности (Ф.И.О. или название группы)
— — Примечание	string (255)		Примечание сущности

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

{
    "request_identifier": "alphapi.recipients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1023",
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 1064,
                "Источник": "Пользователь",
                "Объект": "Василий Николаевич Петров",
                "Примечание": "стажер"
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Группы с пользователями (расширенные)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — GROUP_TABLE_ID	integer (3)		ID таблицы групп пользователей
— — USERS_TABLE_ID	integer (3)		ID таблицы пользователей
— — LOGIN_ID	integer (10)		ID пользователя
— — GROUP_ID	integer (10)		ID группы пользователя
— — ЛогинФИО	string (564)		Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — ФИО	string (255)		Ф.И.О. пользователя
— — Логин	string (50)		Логин пользователя
— — Основная группа	string (50)		Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — Название	string (50)		Название группы пользователей
— — Активный	boolean (1)		Флаг: активен ли пользователь в системе
— — Примечание	string (255)		Примечание пользователя

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

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

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Добавить пользовательскую группу

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
group_name	string (50)	Да	-	Название пользовательской группы
comment	string (255)		-	Примечание
can_be_used_in_route	boolean (1)		-	Флаг: для маршрута

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

{
    "group_name": "Бухгалтеры",
    "comment": "комментарий",
    "can_be_used_in_route": 1
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.users.groups.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Редактировать пользовательскую группу

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.users.groups.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User group deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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.link	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.users.groups.link",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User added to group successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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.unlink	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.users.groups.unlink",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User removed from group successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.users.groups.primary.change",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "User primary group changed successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Группы с пользователями (доступные)

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Роли

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Роли с пользователями (расширенные)

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Роль = 'A'",
    "orderby": "Роль ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.users.roles.ext	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — TABLE_ID	integer (3)		ID таблицы ролей пользователей
— — ROLE_ID	integer (10)		ID роли пользователя
— — LOGIN_ID	integer (10)		ID пользователя
— — Роль	string (255)		Роль, в которую входит пользователь
— — Логин	string (255)		Логин пользователя

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

{
    "request_identifier": "alphapi.users.roles.ext",
    "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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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.favourite.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— fav_id	integer (10)		ID избранного

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

{
    "request_identifier": "alphapi.favourite.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite added successfully",
    "data": {
        "fav_id": 5
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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.favourite.edit	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— fav_id	integer (10)		ID избранного

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

{
    "request_identifier": "alphapi.favourite.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite edited successfully",
    "data": {
        "fav_id": 5
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.favourite.del	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.favourite.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

{
    "request_identifier": "alphapi.favourites.short.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "FAV_ID": 123,
                "PARENTS": "#55##48#",
                "PARENT_TABLE_ID": 6,
                "PARENT_ID": 2,
                "Название": "избранное 1",
                "Примечание": "Текст примечания",
                "OWNER_ID": 34
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Избранные модули

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.dashboard.pages.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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)		-	Примечание

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

{
    "name": "Прибор 1",
    "columns": "",
    "model": "",
    "params": "",
    "location": "",
    "source": "",
    "comment": "комментарий"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.dashboard.add	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Приборы

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Приборы и страницы

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.
1001	Страницы с ID %u не найдена

Сохраненная история приборов

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Страницы приборки

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.dashboard.pages.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— items			Массив элементов
— — FAV_ID	integer (10)		ID страницы
— — Название	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": {
        "items": [
            {
                "FAV_ID": 123,
                "Название": "Первая",
                "DBS_IDS": [
                    15,
                    34
                ]
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.dashboard.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard deleted successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.delall	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.dashboard.delall",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %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.del	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
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.dashboard.pages.del	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.dashboard.pages.del",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Установка режима сохранения значений прибора

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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.dashboard.historymode.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Dashboard history set mode saved successfully"
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
109	Не получено обязательное поле "%s"
110	Некорректное значение обязательного целочисленного поля "%s"
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Скрипты

Действия

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

Условия

URL:

Эмулятор

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

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

{
    "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 (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— 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-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.
101	Некорректный запрос.
102	Токен не получен.
104	Неизвестная БД.
105	Не удалось подключиться к БД. [%s]
106	Ошибка БД: [%s] %s
115	Некорректный PID
116	Превышен лимит подключений
117	Превышен лимит запросов к методу "%s"
401	Токен неизвестен, либо его срок действия истек.

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