АЛЬФАДОК API
Описание API v1.1.266 от 13.09.2024 15:51
Все обращения происходят путём обмена JSON-пакетами на основе описанного функционала.
Авторизация
Авторизация
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| user_login | string (50) | Да | - | Логин доступа к БД |
| user_password | password (50) | Да | - | Пароль доступа к БД |
| db_type | string (10) | Да | - | Тип БД (postgresql/mssql) |
| db_server | string (255) | Да | - | Сервер БД |
| db_port | integer (10) | - | Порт БД | |
| db_name | string (255) | Да | - | Имя БД |
Пример запроса:
{
"user_login": "test@example.com",
"user_password": "P@ssw0rd",
"db_type": "postgresql",
"db_server": "192.168.0.10",
"db_port": 5432,
"db_name": "example_db"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.auth | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| token | string (255) | Выделенный токен доступа (время жизни токена: 30 минут) | |
| valid_to | datetime (YYYY-MM-DD HH:MM:SS) | Дата/время окончания действия токена | |
| ip | string (255) | IP клиента | |
| refresh_token | string (255) | Ключ обновления токена |
Пример ответа:
{
"request_identifier": "alphapi.auth",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
"valid_to": "2001-01-01 01:01:01",
"ip": "145.123.53.25",
"refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
| 1000 | Некорректный порт БД. | |
| 1001 | Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%s^&*()\\_ | |
| 1002 | IP адреса "%s" нет в белом списке | |
| 1003 | База данных не распознана. | |
| 1004 | Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота. | |
| 1005 | Лицензия не найдена. | |
| 1006 | Серийный номер некорректен. | |
| 1007 | Превышено кол-во активных пользователей в лицензии. | |
| 1008 | Пользователь не активирован. | |
| 1009 | Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору. | |
Авторизация для организаций
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| user_login | string (50) | Да | - | Логин доступа к БД |
| user_password | password (50) | Да | - | Пароль доступа к БД |
| org_ident | string (50) | Да | - | Идентификатор организации. Можно получить у разработчика. |
Пример запроса:
{
"user_login": "test@example.com",
"user_password": "P@ssw0rd",
"org_ident": "firma"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.auth | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| token | string (255) | Выделенный токен доступа (время жизни токена: 30 минут) | |
| valid_to | datetime (YYYY-MM-DD HH:MM:SS) | Дата/время окончания действия токена | |
| ip | string (255) | IP клиента | |
| refresh_token | string (255) | Ключ обновления токена | |
| db_type | string (255) | Тип базы данных | |
| storage_url | string (255) | Путь к хранилищу |
Пример ответа:
{
"request_identifier": "alphapi.auth.org",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
"valid_to": "2001-01-01 01:01:01",
"ip": "145.123.53.25",
"refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
"db_type": "mssql",
"storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 126 | Неизвестный идентификатор организации "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
| 1000 | Некорректный порт БД. | |
| 1001 | Пароль должен быть латиницей, иметь как минимум 6 символов и содержать хотя бы одну цифру, одну заглавную букву, одну строчную и один специальный символ из списка !@+#$?<>%s^&*()\\_ | |
| 1002 | IP адреса "%s" нет в белом списке | |
| 1003 | База данных не распознана. | |
| 1004 | Неверный логин и/или пароль. [%s]. Обратитесь к администратору вашего пространства документооборота. | |
| 1005 | Лицензия не найдена. | |
| 1006 | Серийный номер некорректен. | |
| 1007 | Превышено кол-во активных пользователей в лицензии. | |
| 1008 | Пользователь не активирован. | |
| 1009 | Проблема с конфигурацией базы данных, доступ не возможен, обратитесь к администратору. | |
Завершение авторизации
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Обновить токен
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Ошибка обновления токена | |
Справочники
Автозамены
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Активные пользователи
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Активные типы документов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Шаблон = 'A'",
"orderby": "Шаблон ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.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[] | Доступные стандартные маршруты для данного типа документа | |
| — — P_IDS | integer[] | Проекты, которые доступны для документов данного типа документа | |
| — — LT_IDS | integer[] | Типы ссылок по умолчанию | |
Пример ответа:
{
"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 | Токен неизвестен, либо его срок действия истек. | |
Банки
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить адрес
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить банк
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить банковский счет
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить должность
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить значение параметра маски
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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) параметра больше разрешенной длины в маске | |
Добавить избранное
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить контакт
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить правовую форму
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Добавить проект
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Должности
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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) | ФИО пользователя, назначенного на должность | |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Значения параметра маски
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | |
Исполнители
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Исполнители (Расширенный)
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Маски адресов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Параметры типов документов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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" не содержит параметров | |
Пользователи
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Правовые формы
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Проекты
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать адрес
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать банк
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать банковский счет
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать значение параметра маски
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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) параметра больше разрешенной длины в маске | |
Редактировать избранное
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать контакт
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Редактировать правовую форму
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Статусы документов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Типы адресов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Типы документов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Шаблон = 'A'",
"orderby": "Шаблон ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.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[] | Доступные стандартные маршруты для данного типа документа | |
| — — P_IDS | integer[] | Проекты, которые доступны для документов данного типа документа | |
| — — LT_IDS | integer[] | Типы ссылок по умолчанию | |
Пример ответа:
{
"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 | Токен неизвестен, либо его срок действия истек. | |
Типы контактов
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| 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 | Токен неизвестен, либо его срок действия истек. | |
Типы ссылок
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Название = 'A'",
"orderby": "Название ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.link.types.get | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer | Количество записей без учета "limit" | |
| — items | Массив элементов | ||
| — — TABLE_ID | integer (5) | ID таблицы | |
| — — LT_ID | integer (10) | ID типа ссылки | |
| — — Активен | boolean (1) | Флаг активности | |
| — — Название | string (50) | Название типа ссылки | |
| — — Расшифровка | string (255) | Расшифровка типа ссылки | |
| — — Доступен | integer[] | Строка ID объектов сущностей для которых применим тип ссылки | |
| — — Разделы | string (1024) | Разделы системы для которых применим тип ссылки | |
| — — Примечание | string (255) | Примечание типа ссылки | |
Пример ответа:
{
"request_identifier": "alphapi.link.types.get",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"data": {
"count": 1,
"items": [
{
"TABLE_ID": 55,
"LT_ID": 101,
"Активен": true,
"Название": "Основной тип",
"Расшифровка": "пояснение",
"Доступен": [
101,
55
],
"Разделы": "Документы",
"Примечание": "примечание"
}
]
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить адрес
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| address_id | integer (10) | Да | - | ID адреса |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"address_id": 2323
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.address.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.address.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Address deleted successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить банк
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| bank_id | integer (10) | Да | - | ID банка |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"bank_id": 2323
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.banks.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.banks.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Bank deleted successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить банковский счет
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| account_id | integer (10) | Да | - | ID счета |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"account_id": 777
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.clients.bankdetails.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.clients.bankdetails.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1."
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить избранное
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| fav_id | integer (10) | Да | - | ID избранного |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"fav_id": 777
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.favourite.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.favourite.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1."
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить контакт
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| contact_id | integer (10) | Да | - | ID контакта |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"contact_id": 2323233
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.contact.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.contact.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Contact deleted successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Удалить правовую форму
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| lf_id | integer (10) | Да | - | ID правовой формы |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"lf_id": 2323
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.legalforms.del | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.legalforms.del",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Legal form deleted successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Часто используемые значения параметра маски
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| dt_id | integer (10) | Да | - | ID типа документа |
| number | integer (10) | Да | - | Номер параметра |
| count | integer (10) | Да | - | Количество строк |
| value | string (255) | - | Значение параметра |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"dt_id": 104,
"number": 1,
"count": 50,
"value": null
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.type.mask.param.values.frequent | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer | Количество записей без учета "limit" | |
| — items | Массив элементов | ||
| — — Значение | string (480) | Значение | |
| — — Текст | string (480) | Текст | |
Пример ответа:
{
"request_identifier": "alphapi.doc.type.mask.param.values.frequent",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 3.",
"data": {
"count": 3,
"items": [
{
"Значение": "Мужской",
"Текст": "Мужской"
},
{
"Значение": "Женский",
"Текст": "Женский"
},
{
"Значение": "Средний",
"Текст": "Средний"
}
]
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Поручения
Вернуть поручение на доработку
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.return | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.return",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as returned successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Остановить точку маршрута
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 10449,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.stop | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.stop",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as stoped successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Отклонить точку маршрута
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.decline | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — rp_id | integer (10) | ID точки | |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.decline",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point declined successfully",
"data": {
"rp_id": 101
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Отметить точку маршрута как взятую
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.taken | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.taken",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point taken successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Отметить уведомление как прочитаное
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.view | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.view",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as viewed successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Отчитаться о выполнении поручения
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.finish | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.finish",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as finished successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Подтвердить выполнение поручения
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.confirm | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.confirm",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as confirmed successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Пометить прочитанной точку маршрута
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.mark.read | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.mark.read",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point marked as read successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Поручения
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Документ = 'A'",
"orderby": "Документ ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.commissions.get | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer | Количество записей без учета "limit" | |
| — items | Массив элементов | ||
| — — TABLE_ID | integer (3) | ID таблицы | |
| — — RP_ID | integer (10) | ID поручения | |
| — — RPS_ID | integer (10) | ID статуса поручения | |
| — — PARENTS | string (255) | Строка ID родителей экранированных # (последний код всегда равен ID точки поручения) | |
| — — RPT_ID | integer (10) | ID типа поручения (Поручение/Уведомление/Согласование) | |
| — — DOC_ID | integer (10) | ID документа | |
| — — DT_ID | integer (10) | ID типа документа | |
| — — RESPONSIBLE_TABLE_ID | integer (3) | ID таблицы сущности исполнителя (пользователь/должность/группа) | |
| — — RESPONSIBLE_ID | integer (3) | ID сущности исполнителя (пользователь/должность/группа) | |
| — — LOGIN_ID | integer (10) | ID пользователя исполнителя поручения | |
| — — Новое | boolean (1) | Флаг: прочитано ли пользователем поручение | |
| — — Индикатор | integer (3) | Число, отображающее количество рабочих дней до истечения срока поручения (если число отрицателельное, то срок уже прошел) | |
| — — Документ | integer (10) | Внутренний номер документа (равен ID документа) | |
| — — Содержание | string (400) | Содержание документа | |
| — — Дата | datetime (Y-m-d H:i:s) | Дата создания черновика документа | |
| — — Статус | string (50) | Статус документа | |
| — — Контролер | string (255) | Ф.И.О пользователя контролера по документу | |
| — — Регистратор | string (255) | Ф.И.О пользователя регистратора по документу | |
| — — Проект | string (255) | Название проекта документа | |
| — — Тип | string (50) | Тип поручения | |
| — — Тип документа | string (50) | Тип документа | |
| — — Описание | string (100) | Описание поручения | |
| — — Срок | datetime (Y-m-d H:i:s) | Срок поручения | |
| — — Дней | integer (3) | Срок поручения в рабочих днях (может быть пустым, если срок указан явно через дату) | |
| — — Регистрация | datetime (Y-m-d H:i:s) | Дата регистрации документа, если эта функция используется | |
| — — Рег.номер | string (50) | Регистрационный номер документа, если эта функция используется | |
| — — Примечание | string (255) | Примечание поручения | |
| — — Содержание_MASK | string (480) | Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание | |
Пример ответа:
{
"request_identifier": "alphapi.commissions.get",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"data": {
"count": 1,
"items": [
{
"TABLE_ID": 1,
"RP_ID": 1,
"RPS_ID": 1,
"PARENTS": "#10449#",
"RPT_ID": 1,
"DOC_ID": 101,
"RESPONSIBLE_TABLE_ID": 1,
"RESPONSIBLE_ID": 1,
"LOGIN_ID": 1,
"Новое": 1,
"Индикатор": 1,
"Документ": 1,
"Содержание": "Текст содержания",
"Дата": "2001-01-01 01:01:01",
"Статус": "Выполняется",
"Контролер": "Ф.И.О. контролёра",
"Регистратор": "Ф.И.О. регистратора",
"Проект": "Название проекта",
"Тип": "Тип поручения",
"Описание": "Текст описания поручения",
"Срок": "2001-01-01 01:01:01",
"Дней": 1,
"Регистрация": "2001-01-01 01:01:01",
"Рег.номер": "12345",
"Примечание": "Текст примечания",
"Содержание_MASK": null
}
]
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Согласовать точку маршрута
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| comment | string (2048) | - | Текст резолюции/комментария |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"comment": "Комментарий"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.accept | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.accept",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point accepted successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Счетчик поручений
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
Пример запроса:
{
"token": "unique_token_for_30_minutes"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.commissions.count | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer (10) | Общее кол-во | |
| — count_new | integer (10) | Кол-во новых | |
| — count_expired | integer (10) | Кол-во просроченных | |
| — ids | string (255) | Массив ID поручений, разделенных "&" | |
| — ids_new | string (255) | Массив ID новых поручений, разделенных "&" | |
Пример ответа:
{
"request_identifier": "alphapi.commissions.count",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Counter of documents under control",
"data": {
"count": 123,
"count_new": 12,
"count_expired": 1,
"ids": "101&102&103",
"ids_new": "101&102&103"
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Установить исполнителя поручения
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| rp_id | integer (10) | Да | - | ID точки маршрута |
| responsible_table_id | integer (3) | Да | - | ID таблицы сущности исполнителя (пользователь/должность/группа) |
| responsible_id | integer (10) | Да | - | ID сущности исполнителя (пользователь/должность/группа) |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"rp_id": 101,
"responsible_table_id": 1,
"responsible_id": 101
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.doc.routepoint.responsible.set | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
Пример ответа:
{
"request_identifier": "alphapi.doc.routepoint.responsible.set",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Route point responsible set successfully"
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 109 | Не получено обязательное поле "%s" | |
| 110 | Некорректное значение обязательного целочисленного поля "%s" | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Цвета поручений
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Цвет = 'A'",
"orderby": "Цвет ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.commissions.colors | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer | Количество записей без учета "limit" | |
| — items | Массив элементов | ||
| — — TABLE_ID | integer (3) | ID таблицы | |
| — — RP_ID | integer (10) | ID поручения | |
| — — Цвет | integer (10) | Код цвета документа в десятеричной кодировке | |
| — — БлокЦвета | integer (10) | Флаг блокировки цвета, может ли пользователь менять цвет | |
Пример ответа:
{
"request_identifier": "alphapi.commissions.colors",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"data": {
"count": 1,
"items": [
{
"table_id": 1,
"rp_id": 5512,
"Цвет": 123234,
"БлокЦвета": 0
}
]
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Контроль
Документы на контроле
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
| where | string (2048) | - | Строка "WHERE" к запросу BASE | |
| orderby | string (2048) | - | Строка "ORDER BY" к запросу BASE | |
| limit | integer (10) | 0 | Ограничить кол-во записей (0 - без ограничения) | |
| offset | integer (10) | 0 | Кол-во записей, которое необходимо пропустить (0 - с самого начала) | |
| count_only | boolean | - | Вывод только количества строк |
Пример запроса:
{
"token": "unique_token_for_30_minutes",
"where": "Номер = 'A'",
"orderby": "Номер ASC",
"limit": 1,
"offset": 0,
"count_only": false
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.control.get | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message | string (2048) | Сообщение ошибки в запросе | |
| success | boolean (1) | 0 | Флаг успешности запроса |
| success_message | string (2048) | 0 | Сообщение успешности запроса |
| data | Данные | ||
| — count | integer | Количество записей без учета "limit" | |
| — items | Массив элементов | ||
| — — TABLE_ID | integer (3) | ID таблицы | |
| — — DOC_ID | integer (10) | ID документа | |
| — — DOC_CONTROLLER_ID | integer (10) | ID контроллера документа | |
| — — DS_ID | integer (10) | ID статуса документа | |
| — — DT_ID | integer (10) | ID типа документа | |
| — — Активен | boolean (1) | Флаг: активен ли докумнт или нет (документ может быть неактивным, если это черновик или на паузе) | |
| — — Индикатор | integer (3) | Кол-во дней без изменений в документе. Если индикатор = -1, то это значит, что есть изменения требующие внимания контролера | |
| — — Тип | string (50) | Тип документа | |
| — — Номер | integer (10) | Внутренний номер документа (равен ID документа) | |
| — — Дата | date (Y-m-d H:i:s) | Дата создания черновика документа | |
| — — Статус | string (50) | Статус документа | |
| — — Контролер | string (50) | Ф.И.О. пользователя контролера по документу | |
| — — Регистратор | string (50) | Ф.И.О. пользователя регистратора по документу | |
| — — Проект | string (255) | Название проекта документа | |
| — — Содержание | string (400) | Содержание документа | |
| — — Срок | date (Y-m-d H:i:s) | Общий срок документа (не путать со сроком поручения) | |
| — — Регистрация | date (Y-m-d H:i:s) | Дата регистрации документа, если эта функция используется | |
| — — Рег.номер | string (50) | Регистрационный номер документа, если эта функция используется | |
| — — Выполнение | integer (3) | Процент выполнения маршрута документа (отношение выполненых точек маршрута к общему числу) | |
| — — Исполнители | string (255) | ФИО текущих исполнителей по документу через запятую (до 3 человек) | |
| — — Комментарий | string (255) | Комментарий документа | |
| — — Содержание_MASK | string (1024) | Маска поля ввода "Содержание" (используется для форматированного ввода текста в поле содержание) | |
| — — Новое | boolean (1) | Признак новое (Индикатор = -1) | |
Пример ответа:
{
"request_identifier": "alphapi.control.get",
"error": false,
"error_code": 0,
"error_message": "",
"success": true,
"success_message": "Number of records 1.",
"data": {
"count": 1,
"items": [
{
"TABLE_ID": 1,
"DOC_ID": 101,
"DOC_CONTROLLER_ID": 1070,
"DS_ID": 101,
"DT_ID": 1,
"Активен": 1,
"Индикатор": 12,
"Тип": "Документ",
"Номер": 101,
"Дата": "2001-01-01 01:01:01",
"Статус": "Выполняется",
"Контролер": "Иванов И.И.",
"Регистратор": "Петров П.П.",
"Проект": "Название проекта",
"Содержание": "Содержание документа",
"Срок": "2001-01-01 01:01:01",
"Регистрация": "2001-01-01 01:01:01",
"Рег.номер": "",
"Выполнение": 33,
"Исполнители": "Сидоров С.С.",
"Комментарий": "Комментарий к документу",
"Содержание_MASK": "",
"Новое": 1
}
]
}
}
| Описание |
| Код | Сообщение | Описание |
| HTTP-заголовки | ||
|---|---|---|
| 400 | Некорректный запрос. | Запрос не содержит необходимых инструкций JSON. |
| 400 | Проверьте правильность передаваемых ключей параметров. | Отсутсвуют обязательные параметры запроса. |
| 403 | Введённая пара логин/пароль некорректны. | Переданные параметры логин/пароль не найдены в БД. |
| 403 | Ваш аккаунт деактивирован. Обратитесь к администратору системы. | Аккаунт с парой логин/пароль деактивирован в подсистеме. |
| 200 | Запрос прошёл успешно | Необходимо прочитать ответный пакет данных. |
| Пользовательские ошибки | ||
| 100 | Превышен лимит запросов. | |
| 101 | Некорректный запрос. | |
| 102 | Токен не получен. | |
| 104 | Неизвестная БД. | |
| 105 | Не удалось подключиться к БД. [%s] | |
| 106 | Ошибка БД: [%s] %s | |
| 115 | Некорректный PID | |
| 116 | Превышен лимит подключений | |
| 117 | Превышен лимит запросов к методу "%s" | |
| 401 | Токен неизвестен, либо его срок действия истек. | |
Счетчик документов на контроле
| Параметр | Тип | Обязателен | По умолчанию | Описание |
| token | string | Да | - | Ключ запроса API, полученный при авторизации |
Пример запроса:
{
"token": "unique_token_for_30_minutes"
}
| Параметр | Тип | По умолчанию | Описание |
| request_identifier | string (255) | alphapi.control.count | Информационный идентификатор запроса |
| error | boolean (1) | 0 | Флаг наличия ошибки в запросе |
| error_code | integer (3) | Код ошибки в запросе | |
| error_message |