АЛЬФА ДОК API

Описание API v1.1.127 от 01.12.2023 21:42

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

Авторизация

URL:

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

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

Обновление токена

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

Справочники

Автозамены

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Замена = 'A'",
    "orderby": "Замена ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

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

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

{
    "request_identifier": "alphapi.autoreplaces.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 135,
                "Слово": "коробка",
                "Замена": "упаковка"
            }
        ]
    }
}

Описание

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

Добавить банковский счет

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 11,
    "parent_id": 113,
    "bank_name": "Тинькофф",
    "bik": "123456789",
    "kc": "12345678901234567890",
    "account": "34534567890123456789",
    "comment": "комментарий"
}

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

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

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

Описание

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

Добавить должность

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parents	string (255)		-	Строка ID родителей экранированных # (последний код всегда равен ID точки должности)
name	string (255)	Да	-	Название должности
login_id	integer (10)	Да	-	ID пользователя, который занимает должность
sub_unit	string (255)		-	Подразделение должности
comment	string (255)		-	Комментарий должности
active	boolean (1)		-	Флаг активности должности

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "name": "Главный бухгалтер",
    "login_id": 101,
    "sub_unit": "Бухгалтерия",
    "comment": "комментарий",
    "active": 1
}

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

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

{
    "request_identifier": "alphapi.position.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Position added successfully",
    "data": {
        "pos_id": 5
    }
}

Описание

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

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

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parents	string (255)		-	Строка ID родителей экранированных # (последний код всегда равен ID избранного)
parent_table_id	integer (10)	Да	-	ID таблицы сущности
parent_id	integer (10)	Да	-	ID сущности
name	string (255)	Да	-	Название
comment	string (255)		-	Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "parent_table_id": 101,
    "parent_id": 101,
    "name": "Изб.1",
    "comment": "комментарий"
}

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

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

{
    "request_identifier": "alphapi.favourite.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite added successfully",
    "data": {
        "fav_id": 5
    }
}

Описание

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

Добавление адреса

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parent_table_id	integer (5)	Да	-	ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id	integer (10)	Да	-	ID сущности
address_type	string (50)	Да	-	Тип адреса
address	string (255)	Да	-	Адрес
comment	string (255)		-	Примечание адреса
mask	string (305)		-	Маска поля ввода "Адреса", используется для форматированного ввода текста в поле адрес

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 3,
    "address_type": "поставщик",
    "address": "тел. +738459663",
    "comment": "примечание",
    "mask": ""
}

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

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

{
    "request_identifier": "alphapi.address.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address added successfully",
    "data": {
        "address_id": 5
    }
}

Описание

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

Добавление банка

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.banks.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank added successfully",
    "data": {
        "bank_id": 5
    }
}

Описание

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

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

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
dt_id	integer	Да	-	ID типа документа
number	integer	Да	-	Номер параметра
value	text (255)	Да	-	Значение параметра

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

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

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.docs.directory.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.docs.directory.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Directory added successfully"
}

Описание

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

Добавление контакта

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parent_table_id	integer (5)	Да	-	ID таблицы типа сущности, может принимать значения (55 - документ, 6 - контрагент)
parent_id	integer (10)	Да	-	ID сущности
contact_type	string (50)	Да	-	Тип контакта
contact	string (255)	Да	-	Контакт
comment	string (255)		-	Примечание контакта
mask	string (305)		-	Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 55,
    "parent_id": 3,
    "contact_type": "поставщик",
    "contact": "тел. +738459663",
    "comment": "примечание",
    "mask": ""
}

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

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

{
    "request_identifier": "alphapi.contact.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact added successfully",
    "data": {
        "contact_id": 5
    }
}

Описание

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

Добавление правовой формы

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.legalforms.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form added successfully",
    "data": {
        "lf_id": 5
    }
}

Описание

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

Добавление проекта

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
parents	string (255)		-	Строка ID родителей экранированных # (последний код всегда равен ID проекта)
name	string (255)	Да	-	Название
enable	boolean (1)		-	Флаг активности
login_id	integer (10)	Да	-	LOGIN_ID ответственного по проекту
planschedule	date (YYYY-MM-DD)	Да	-	Дата план графика проекта
key	string (255)		-	Поле связи проекта со внешними системами
color	integer (10)		-	Цветовой тег проекта, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736
comment	string (255)		-	Название

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

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

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

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

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

Описание

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

Значения справочника

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.docs.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "value": "Заявление"
            },
            {
                "value": "Предложение"
            },
            {
                "value": "Жалоба"
            }
        ]
    }
}

Описание

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) параметра не найден в маске

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

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
address_id	integer (10)	Да	-	ID адреса
address_type	string (50)	Да	-	Тип адреса
address	string (255)	Да	-	Адрес
comment	string (255)		-	Примечание адреса
mask	string (305)		-	Маска поля ввода "Адреса", используется для форматированного ввода текста в поле адрес

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

{
    "token": "unique_token_for_30_minutes",
    "address_id": 2323233,
    "address_type": "офис",
    "address": "Москва, пр-т Ленина, 5",
    "comment": "примечание",
    "mask": ""
}

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

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

{
    "request_identifier": "alphapi.address.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Address edited successfully",
    "data": {
        "address_id": 5
    }
}

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.banks.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Bank edited successfully",
    "data": {
        "bank_id": 5
    }
}

Описание

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

Редактирование избранное

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
fav_id	integer (10)	Да	-	ID избранного
parents	string (255)		-	Строка ID родителей экранированных # (последний код всегда равен ID избранного)
name	string (255)	Да	-	Название
comment	string (255)		-	Примечание

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

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 15,
    "parents": "#101##102#",
    "name": "Изб.1",
    "comment": "комментарий"
}

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

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

{
    "request_identifier": "alphapi.favourite.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Favourite edited successfully",
    "data": {
        "fav_id": 5
    }
}

Описание

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

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

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
contact_id	integer (10)	Да	-	ID контакта
contact_type	string (50)	Да	-	Тип контакта
contact	string (255)	Да	-	Контакт
comment	string (255)		-	Примечание контакта
mask	string (305)		-	Маска поля ввода "Контакта", используется для форматированного ввода текста в поле контакт

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

{
    "token": "unique_token_for_30_minutes",
    "contact_id": 2323233,
    "contact_type": "поставщик",
    "contact": "тел. +738459663",
    "comment": "примечание",
    "mask": ""
}

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

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

{
    "request_identifier": "alphapi.contact.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Contact edited successfully",
    "data": {
        "contact_id": 5
    }
}

Описание

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

Редактирование правовой формы

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.legalforms.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Legal form edited successfully",
    "data": {
        "lf_id": 5
    }
}

Описание

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

Редактировать банковский счет

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "account_id": 777,
    "parent_table_id": 11,
    "parent_id": 113,
    "bank_name": "Тинькофф",
    "bik": "123456789",
    "kc": "12345678901234567890",
    "account": "34534567890123456789",
    "comment": "комментарий"
}

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

Справочник банков

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.banks.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 31,
                "ROW_ID": 11,
                "BANK_ID": 34,
                "Название": "Сбербанк",
                "БИК": "123456789",
                "КС": "12345678901234567890",
                "Примечание": "примечание"
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Объект = 'A'",
    "orderby": "Объект ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

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

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

{
    "request_identifier": "alphapi.recipients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1023",
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 1064,
                "Источник": "Пользователь",
                "Объект": "Василий Николаевич Петров",
                "Примечание": "стажер"
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Логин = 'A'",
    "orderby": "Логин ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.users.groups.get	Информационный идентификатор запроса
error	boolean (1)	0	Флаг наличия ошибки в запросе
error_code	integer (3)		Код ошибки в запросе
error_message	string (2048)		Сообщение ошибки в запросе
success	boolean (1)	0	Флаг успешности запроса
success_message	string (2048)	0	Сообщение успешности запроса
data			Данные
— count	integer		Количество записей без учета "limit"
— items			Массив элементов
— — GROUP_TABLE_ID	integer (3)		ID таблицы групп пользователей
— — USERS_TABLE_ID	integer (3)		ID таблицы пользователей
— — LOGIN_ID	integer (10)		ID пользователя
— — GROUP_ID	integer (10)		ID группы пользователя
— — ЛогинФИО	string (564)		Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — ФИО	string (255)		Ф.И.О. пользователя
— — Логин	string (50)		Логин пользователя
— — Основная группа	string (50)		Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — Название	string (50)		Название группы пользователей
— — Активный	boolean (1)		Флаг: активен ли пользователь в системе
— — Примечание	string (255)		Примечание пользователя

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

{
    "request_identifier": "alphapi.users.groups.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "GROUP_TABLE_ID": 2,
                "USERS_TABLE_ID": 1,
                "LOGIN_ID": 102,
                "GROUP_ID": 1,
                "ЛогинФИО": "Sync-1 \/яяСинхронизатор\/",
                "ФИО": "Василий Николаевич Петров",
                "Логин": "стажер",
                "Основная группа": "Все пользователи",
                "Название": "Все пользователи",
                "Активный": 1,
                "Примечание": null
            }
        ]
    }
}

Описание

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

Справочник исполнителей

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.routespoints.responsibles.directory.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1071",
                "RESPONSIBLE_TABLE_ID": 101,
                "RESPONSIBLE_ID": 10,
                "Сервер": 1,
                "Исполнитель": "Сидоров С.С.",
                "Должность": "Директор",
                "ФИО": "Сидоров С.С.",
                "LOGIN_ID": 1
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Логин = 'A'",
    "orderby": "Логин ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

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

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

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

Описание

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

Справочник правовых форм

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "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 типа документа
— — EXT_DOCS	string (255)
— — EXT_P	string (255)
— — EXT_LT	string (255)
— — Нумерация	integer (3)		Нумерация
— — Шаблон	string (50)		Шаблон
— — Активен	boolean (1)		Флаг активности
— — Название	string (50)		Название
— — Описание	string (255)		Описание
— — Маска	string (480)		Маска
— — Параметры	string (1024)		Параметры
— — Примечание	string (255)		Примечание

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

{
    "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,
                "EXT_DOCS": null,
                "EXT_P": "#101#",
                "EXT_LT": null,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Статус = 'A'",
    "orderby": "Статус ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

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

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

{
    "request_identifier": "alphapi.docs.statuses.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "DS_ID": 3,
                "Статус": "Выполняется"
            }
        ]
    }
}

Описание

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

Типы адресов

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.address.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "поставщик"
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.contact.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Тип": "поставщик11701007"
            }
        ]
    }
}

Описание

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

Типы ссылок

URL:

Эмулятор

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

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

{
    "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)		Расшифровка типа ссылки
— — Доступен	string (1024)		Строка 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#",
                "Разделы": "Документы",
                "Примечание": "примечание"
            }
        ]
    }
}

Описание

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

Удаление адреса

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "address_id": 2323
}

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

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

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

Описание

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

Удаление банка

URL:

Эмулятор

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

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

{
    "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	Сообщение успешности запроса
data			Данные
— bank_id	integer (10)		ID банка

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

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

Описание

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

Удаление контакта

URL:

Эмулятор

Параметр	Тип	Обязателен	По умолчанию	Описание
token	string	Да	-	Ключ запроса API, полученный при авторизации
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	Сообщение успешности запроса
data			Данные
— contact_id	integer (10)		ID контакта

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

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

Описание

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

Удаление правовой формы

URL:

Эмулятор

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

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

{
    "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	Сообщение успешности запроса
data			Данные
— lf_id	integer (10)		ID правовой формы

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

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

Описание

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

Удалить банковский счет

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "account_id": 777
}

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

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

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

Описание

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

Удалить избранное

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "fav_id": 777
}

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

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

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

Описание

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

Поручения

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "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 документа
— — 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 (100)		Описание поручения
— — Срок	datetime (Y-m-d H:i:s)		Срок поручения
— — Дней	integer (3)		Срок поручения в рабочих днях (может быть пустым, если срок указан явно через дату)
— — Регистрация	datetime (Y-m-d H:i:s)		Дата регистрации документа, если эта функция используется
— — Рег.номер	string (50)		Регистрационный номер документа, если эта функция используется
— — Примечание	string (255)		Примечание поручения
— — Содержание_MASK	string (480)		Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание

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

{
    "request_identifier": "alphapi.commissions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 1,
                "RPS_ID": 1,
                "PARENTS": "#10449#",
                "RPT_ID": 1,
                "DOC_ID": 101,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 1,
                "LOGIN_ID": 1,
                "Новое": 1,
                "Индикатор": 1,
                "Документ": 1,
                "Содержание": "Текст содержания",
                "Дата": "2001-01-01 01:01:01",
                "Статус": "Выполняется",
                "Контролер": "Ф.И.О. контролёра",
                "Регистратор": "Ф.И.О. регистратора",
                "Проект": "Название проекта",
                "Тип": "Тип поручения",
                "Описание": "Текст описания поручения",
                "Срок": "2001-01-01 01:01:01",
                "Дней": 1,
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "12345",
                "Примечание": "Текст примечания",
                "Содержание_MASK": null
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "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	Токен неизвестен, либо его срок действия истек.

Контроль

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

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.control.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DOC_ID": 101,
                "DOC_CONTROLLER_ID": 1070,
                "DS_ID": 101,
                "DT_ID": 1,
                "Активен": 1,
                "Индикатор": 12,
                "Тип": "Документ",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Статус": "Выполняется",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта",
                "Содержание": "Содержание документа",
                "Срок": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "",
                "Выполнение": 33,
                "Исполнители": "Сидоров С.С.",
                "Комментарий": "Комментарий к документу",
                "Содержание_MASK": "",
                "Новое": 1
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Цвет = 'A'",
    "orderby": "Цвет ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}

Параметр	Тип	По умолчанию	Описание
request_identifier	string (255)	alphapi.control.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 таблицы
— — DOC_ID	integer (10)		ID документа
— — Цвет	integer (10)		Код цвета документа в десятеричной кодировке
— — БлокЦвета	integer (10)		Флаг блокировки цвета, может ли пользователь менять цвет
— — ЦветИсточник	string (255)		Описание источника цвета документа

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

{
    "request_identifier": "alphapi.control.colors",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "table_id": 1,
                "doc_id": 5512,
                "Цвет": 123234,
                "БлокЦвета": 0,
                "ЦветИсточник": "Текст примечания"
            }
        ]
    }
}

Описание

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

Документы

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

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.docs.audit.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1234567890,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Контролер": "Ремесленников Р.Р.",
                "Регистратор": "Дорофеев Д.Д.",
                "Дата время": "2001-01-01 01:01:01",
                "Параметр01": "Спасибо. Выполнено",
                "Параметр02": "Успешно, ID 10238",
                "Станция": "ALPHA101",
                "Пользователь": "Логин пользователя",
                "Приоритет события": 2,
                "Событие": "Добавление комментария",
                "Элемент": null
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

{
    "request_identifier": "alphapi.docs.links.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 1,
                "DOC_ID": 101,
                "Ссылка": "Ссылка",
                "Активен": 1,
                "Тип": "Тип",
                "Номер": 1,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Стандартный",
                "Содержание": "Текст",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Пользователь": "Иванов И.И.",
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes"
}

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

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

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

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

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

Описание

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

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

URL:

Эмулятор

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

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

{
    "token": "unique_token_for_30_minutes",
    "where": "Содержание = 'A'",
    "orderby": "Содержание ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false,
    "include_mask_params": false
}

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

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

{
    "request_identifier": "alphapi.docs.int.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ROW_ID": 10,
                "DOC_ID": 1021,
                "DT_ID": 1,
                "P_ID": 1012,
                "REGISTRAR_ID": 102,
                "CONTROLLER_ID": 102,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Активен": true,
                "Содержание": "Текст",
                "Комментарий": "коммент",
                "ПГ": "2001-01-01 01:01:01",
                "Запуск": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Номер": "Тест3234",
                "Progress": "#1041##1042##1044#",
                "Черновик": false,
                "MASK_PARAMS": [
                    {
                        "number": 1,
                        "group": 1,
                        "name": "Получатель",
                        "type": "RTRIM(REPLACE(%s,'  ',''))",
                        "mask": "cccccccccc-ccccccccccc-cccccc",
                        "value": "Иванов П.С."
                    }
                ]
            }
        ]
    }
}

Описание

HTTP-заголовки
Код	Сообщение	Описание
400	Некорректный запрос.	Запрос не содержит необходимых инструкций JSON.
400	Проверьте правильность передаваемых ключей параметров.	Отсутсвуют обязательные параметры запроса.
403	Введённая пара логин/пароль некорректны.	Переданные параметры логин/пароль не найдены в БД.
403	Ваш аккаунт деактивирован. Обратитесь к администратору системы.	Аккаунт с парой логин/пароль деактивирован в подсистеме.
200	Запрос прошёл успешно	Необходимо прочитать ответный пакет данных.
Пользовательские ошибки
100	Превышен лимит запросов.

Справочники

Поручения

Контроль

Документы

Документ

Контрагенты

Маршрут

Системные

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

Приборка