Описание API v1.1.330 от 17.01.2025 14:42

Все обращения происходят путём обмена 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^&*()\\_
1002IP адреса "%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^&*()\\_
1002IP адреса "%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.autoreplaces.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — FAV_ID integer (10) ID замены
— — Слово string (255) Слово
— — Замена string (255) Замена

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

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

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

{
    "request_identifier": "alphapi.users.active",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "EXT_GROUPS": "#1#",
                "Активный": 1,
                "Логин": "alpha-101",
                "Основная группа": "Основная группа",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Примечание": "Текст примечания",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Сервер": 1
            }
        ]
    }
}
Описание
КодСообщениеОписание
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:
Эмулятор
Аудит должностей
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 Информационный идентификатор запроса
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",
    "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.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.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.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 таблицы
— — 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.ext",
    "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, полученный при авторизации
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, полученный при авторизации
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,
    "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 Информационный идентификатор запроса
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",
    "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 Информационный идентификатор запроса
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",
    "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 Информационный идентификатор запроса
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",
    "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.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 Массив элементов
— — 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.ext",
    "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.routespoints.responsibles.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 Массив элементов
— — 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.routespoints.responsibles.directory.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.routespoints.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.routespoints.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.contact.ext.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.contact.ext.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 Информационный идентификатор запроса
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",
    "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[] Да - Массив идентификаторов типов документов

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

{
    "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.legalforms.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.legalforms.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, полученный при авторизации
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, полученный при авторизации
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, полученный при авторизации
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.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 Массив элементов
— — DS_ID integer (3) ID статуса
— — Статус string (255) Статус

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

{
    "request_identifier": "alphapi.docs.statuses.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.routespoints.statuses Информационный идентификатор запроса
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.routespoints.statuses",
    "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.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.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:
Эмулятор