Описание API v1.1.49 от 22.05.2023 13:54

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

Авторизация

Авторизация #

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

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

{
    "user_login": "test@example.com",
    "user_password": "P@ssw0rd",
    "db_type": "postgresql",
    "db_server": "192.168.0.10",
    "db_port": 5432,
    "db_name": "example_db"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.auth Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
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",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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) Дата/время окончания действия токена
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",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "db_type": "mssql",
    "storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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) Дата/время окончания действия токена
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",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочники

Автозамены #

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

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

Параметр Тип Обязателен По умолчанию Описание
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": "3432352553",
    "kc": "64354334",
    "account": "21213213",
    "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
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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": "3432352553",
    "kc": "64354334",
    "account": "21213213",
    "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
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Типы адресов #

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

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

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

Типы ссылок #

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

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

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

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

Поручения

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Контроль

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

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

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

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

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

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

Документы

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

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

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

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

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

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

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

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

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

Список комментариев/резолюций документов #

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

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

{
    "request_identifier": "alphapi.system.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С.",
                "Элемент": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "request_identifier": "alphapi.docs.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 101,
                "Активен": 1,
                "Документ": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название_файла.docx",
                "Редакция": 1,
                "Пользователь": "Сидоров С.С.",
                "Атрибуты": "",
                "Примечание": null,
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Индикатор": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
doc_ids integer[] Да Массив идентификаторов документов

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

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

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

{
    "request_identifier": "alphapi.docs.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 1010,
                "Номер": 1,
                "Файл": "Документ.pdf",
                "Редакция": 2,
                "Пользователь": "Иванов И.И.",
                "ЭП": 0.88
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Документ

Добавление маршрута #

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
DOC_ID integer Да ID документа
RP_ID integer[] Массив ID точек маршрута документа, с которого копируем
PARENT_DOC_ID integer Да ID маршрута или документа, с которого копируем
PARENTS text (255) Вложенность
InitLINKS text (255) Входящие связи
routePointsResponsibles Массив параметров для точек маршрута с неопределенным исполнителем
— RESPONSIBLE_TABLE_ID integer Да Идентификатор таблицы ответственного. Допустимые значения: 1 - Пользователи, 2 - Группы, 48 - Должности, 59 - Системный ID
— RESPONSIBLE_ID integer Да Идентификатор ответственного
— description string (100) Описание
— days integer (3) Срок в рабочик днях (NULL, если срок указывается через точную дату)
— end_date date (YYYY-MM-DD) Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
— comment string (255) Комментарий

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

{
    "token": "unique_token_for_30_minutes",
    "DOC_ID": 101,
    "RP_ID": [
        1001,
        1002,
        1003
    ],
    "PARENT_DOC_ID": 100,
    "PARENTS": "",
    "InitLINKS": "",
    "routePointsResponsibles": [
        {
            "RESPONSIBLE_TABLE_ID": 2,
            "RESPONSIBLE_ID": 1,
            "description": "Особое описание",
            "days": null,
            "end_date": "2022-12-31",
            "comment": "Особый комментарий"
        },
        {
            "RESPONSIBLE_TABLE_ID": 1,
            "RESPONSIBLE_ID": 1070,
            "description": "Особое описание 2",
            "days": 2,
            "end_date": null,
            "comment": "Особый комментарий 2"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.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.doc.route.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route added successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление ссылки #

Добавление точки маршрута #

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа
rpt_id integer (10) Да ID типа точки маршрута (поручение/уведомление/согласование)
responsible_table_id integer (3) Да ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да ID сущности исполнителя (пользователь/должность/группа)
parents text (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
links text (255) Строка ID входящих зависимостей экранированных #
end_date date (YYYY-MM-DD) Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
days integer (3) Срок в рабочик днях (NULL, если срок указывается через точную дату)
content text (100) Да Описание точки маршрута (что требуется от исполнителя)
comment text (255) Примечание точки маршрута
parent_id integer (10) ID точки маршрута, с которой была скопирована текущая (применяется в стандартных маршрутах)

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point added successfully",
    "data": {
        "rp_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление черновика документа #

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
dt_id integer (10) Да ID типа документа
p_id integer (10) Да ID проекта документа
controller_id integer (10) Да ID пользователя контролера документа
plan_end_date date (YYYY-MM-DD) Срок документа
content text (255-1024) Да Содержание документа (длина поля зависит от БД)
comment text (255) Комментарий документа
pg date (YYYY-MM-DD) План-график (рудимент)
start date (YYYY-MM-DD) Дата планового запуска документа в работу
reg_date date (YYYY-MM-DD) Дата регистрации документа
reg_number varchar (50) Регистрационный номер документа
color integer (4) Цветовой тег проекта, цвет передается в кодировке R255+G255+B255
params Массив параметров содержания документа
— number integer (10) Номер параметра
— name string (255) Именование параметра
— value string (255) Значение

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

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

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

{
    "request_identifier": "alphapi.doc.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

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

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

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

{
    "request_identifier": "alphapi.doc.access",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Наследуемый.1010748.1019264",
                "ACCESS_ID": 1077,
                "DOC_ID": 1010748,
                "PROVIDER_TABLE_ID": 49,
                "PROVIDER_ID": 103,
                "RECIPIENT_TABLE_ID": 2,
                "RECIPIENT_ID": 1,
                "Тип": "Наследуемый",
                "Источник": "Группы пользователей",
                "Объект": "Администраторы",
                "Примечание": "Встроенная группа",
                "Родитель": "Проект: Договора и ДС"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Запуск или постановка документа на паузу #

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

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

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

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

{
    "request_identifier": "alphapi.doc.activation.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Изменение точки маршрута #

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
doc_id integer (10) Да ID документа
rpt_id integer (10) Да ID типа точки маршрута (поручение/уведомление/согласование)
responsible_table_id integer (10) Да ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да ID сущности исполнителя (пользователь/должность/группа)
parents text (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
links text (255) Строка ID входящих зависимостей экранированных #
end_date date (YYYY-MM-DD) Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
days integer (10) Срок в рабочик днях (NULL, если срок указывается через точную дату)
content text (100) Да Описание точки маршрута (что требуется от исполнителя)
comment text (255) Примечание точки маршрута
parent_id integer (10) ID точки маршрута, с которой была скопирована текущая (применяется в стандартных маршрутах)

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

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

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

{
    "request_identifier": "alphapi.doc.routepoint.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point edited successfully",
    "data": {
        "rp_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

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

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

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

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

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

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

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

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

{
    "request_identifier": "alphapi.doc.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document stoped successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Пометить документ как прочитанный #

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

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

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

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

{
    "request_identifier": "alphapi.doc.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.views.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 Массив элементов
— — KEY_ID integer (10) ID-ключ
— — DOC_ID integer (10) ID документа
— — Активен boolean (1) Флаг активности
— — Документ integer (10) ID документа
— — ДатаДокумента date (Y-m-d H:i:s) Дата создания черновика документа
— — Срок date (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен date (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Пользователь string (255) Логин пользователя
— — Дата date (Y-m-d H:i:s) Дата просмотра
— — Активно boolean (1) Флаг активности

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

{
    "request_identifier": "alphapi.docs.views.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "KEY_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Документ": "",
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Главный",
                "Содержание": "Тест",
                "Пользователь": "Сидоров С.С.",
                "Дата": "2001-01-01 01:01:01",
                "Активно": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Смена контролера #

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

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

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

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

{
    "request_identifier": "alphapi.doc.controller.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Controller setted successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список поручений по документу #

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
doc_id integer Да 10 ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.routespoints.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 101,
                "LOGIN_ID": 101,
                "RPT_ID": 2,
                "RPS_ID": 3,
                "PARENTS": "#101#",
                "LINKS": null,
                "Уровень": 0,
                "Номер": 0,
                "Предыдущий": "",
                "Тип": "Уведомление",
                "Срок": "2001-01-01 01:01:01",
                "Дней": 3,
                "Выполнено": "",
                "Исполнитель": "Имя",
                "Контролер": "Имя",
                "Статус": "Просрочено",
                "Описание": "Добавлен комментарий",
                "Примечание": "Добавлен комментарий",
                "Индикатор": -9,
                "Создана": "2001-01-01 01:01:01",
                "Флаг": 1,
                "Родитель": 101
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список простых ЭП файлов документа #

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

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

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

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

{
    "request_identifier": "alphapi.doc.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "count": 1,
    "data": {
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 101,
                "Номер": 2,
                "Файл": "Приложение.doc",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "ЭП": -4.94714764660603
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список резолюций по документу #

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
doc_id integer (10) Да ID документа

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

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

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

{
    "request_identifier": "alphapi.doc.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "CHILD_ID": 10,
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С.",
                "Элемент": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Счетчики для документа #

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

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

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

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

{
    "request_identifier": "alphapi.doc.counters",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Incorrect text identifier \"counter_of_documents_success\".",
    "data": {
        "comments_count": 55,
        "files_count": 12,
        "links_count": 1,
        "contractor_count": 6,
        "views_count": 5
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Удаление документа #

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

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

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

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

{
    "request_identifier": "alphapi.doc.delete",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Doc deleted successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Удаление ссылки #

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

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
doc_id integer (10) Да ID документа

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

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

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
doc_id integer (10) Да ID документа

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

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

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

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

Контрагенты

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

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

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

{
    "request_identifier": "alphapi.clients.addresses.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "ADDRESS_ID": 101,
                "CLIENT_ID": 34,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "Номер": 444,
                "Тип контрагента": "Простой",
                "Название": "ООО Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов А.А.",
                "Тип": "Поставщик",
                "Адрес": "тел. 83504332, почта top@sales.com",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01",
                "Адрес_MASK": "",
                "Адрес_MASK_COND": ""
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "request_identifier": "alphapi.clients.audit.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1883,
                "CLIENT_ID": 107,
                "Дата время": "2022-06-03 12:29:05",
                "Параметр01": "value1",
                "Параметр02": "value2",
                "Станция": "irisDB01",
                "Пользователь": "user01",
                "Номер": 107,
                "Тип": "Соб. юр. лицо",
                "Название": "234524524",
                "Приоритет события": 5,
                "Событие": "Изменение ОГРН юридического лица"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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": "[ACCOUNT_ID] = 1",
    "orderby": "[ACCOUNT_ID] ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.clients.bankdetails.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — ACCOUNT_ID integer (10) ID реквизитов
— — CLIENT_ID integer (10) ID контрагента
— — Номер integer (10) Номер контрагента, равен его ID
— — Тип контрагента string (50) Тип контрагента
— — Название string (255) Название контрагента
— — Регион string (255) Регион контрагента
— — Сегмент string (255) Сегмент контрагента
— — Приоритет string (255) Приоритет контрагента
— — Менеджер string (255) Менеджер контрагента
— — Банк string (255) Наименование банка
— — БИК string (9) БИК
— — КС string (20) Корреспондентский счет
— — РС string (20) Расчетный счет
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.clients.bankdetails.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ACCOUNT_ID": 2,
                "CLIENT_ID": 4,
                "Номер": 4,
                "Тип контрагента": "простой",
                "Название": "ООО Фарма",
                "Регион": "Москва",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов Иван Иванович",
                "Банк": "Сбербанк",
                "БИК": "293474454",
                "КС": "40084545549348834335",
                "РС": "40084545549000004335",
                "Примечание": "Текст"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
parents string (255) Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
type_id integer (10) Да ID типа контрагента (1 - Клиент(Верхний уровень клиента), 2 - Подразделение(Обычно используется для объединения клиентов в различные группы), 3 - Юридическое лицо(Магазины и т.д.), 4 - ИП Индивидуальный предприниматель, 5 - Соб. юр. лицо, 6 - Частное лицо)
manager_id integer (10) Да ID менеджера
region_id integer (10) Да ID региона
segment_id integer (10) Да ID сегмента
category string (1) Да Категория контрагнета, может принимать следующие значения: A,B,C
name string (255) Да Наименование контрагента
discount float (255) Размер скидки
comment string (255) Комментарий контрагента
inn string (50) ИНН юридического лица
kpp string (50) КПП юридического лица
okato string (50) ОКАТО юридического лица
okpo string (50) ОКПО юридического лица
position string (255) Должность
document string (255) Документ удостоверяющий личность контрагента
ogrn string (50) ОГРН юридического лица
lf_id integer (10) ID правовой формы юридического лица
city string (255) Город контрагента
code string (255) Внешний код контрагента

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

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "type_id": 3,
    "manager_id": 112,
    "region_id": 1931,
    "segment_id": 24,
    "category": "A",
    "name": "Петров А.А.",
    "discount": 10.5,
    "comment": "комментарий",
    "inn": "4363435434",
    "kpp": "56785658853",
    "okato": "2343243856780",
    "okpo": "7890754342",
    "position": "Директор",
    "document": "паспорт",
    "ogrn": "4578989045",
    "lf_id": 1,
    "city": "Москва",
    "code": "к484833"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.client.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— client_id integer (10) ID контрагента

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

{
    "request_identifier": "alphapi.client.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client added successfully",
    "data": {
        "client_id": 5
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "request_identifier": "alphapi.clients.docs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 1,
                "DOC_ID": 101,
                "CLIENT_ID": 234,
                "Ссылка": "Ссылка",
                "Активен": 1,
                "Тип": "Тип",
                "Номер": 1,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Стандартный",
                "Содержание": "Текст",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Пользователь": "Иванов И.И.",
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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.clients.access.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — CustomKey string (1023) Составной идентификатор, уникальный в рамках данного справочника (состоит из Типа, PROVIDER_ID, RECIPIENT_TABLE_ID и RECIPIENT_ID)
— — PROVIDER_TABLE_ID integer (3) ID таблицы источника доступа
— — PROVIDER_ID integer (10) ID источника доступа
— — RECIPIENT_TABLE_ID integer (3) ID таблицы получателя доступа
— — RECIPIENT_ID integer (10) ID получателя доступа
— — TABLE_ID integer (3) ID таблицы
— — CLIENT_ID integer (10) ID контрагента
— — Тип string (255) Тип доступа
— — Источник string (50) Источник доступа
— — Объект string (255) Объект доступа
— — Родитель integer (255) Родитель доступа
— — Примечание integer (255) Примечание доступа

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

{
    "request_identifier": "alphapi.clients.access.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Назначенный.101.1.102",
                "PROVIDER_TABLE_ID": 6,
                "PROVIDER_ID": 101,
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 102,
                "TABLE_ID": 6,
                "CLIENT_ID": 101,
                "Тип": "Назначенный",
                "Источник": "Пользователи",
                "Объект": "Разработчик",
                "Родитель": "test296764",
                "Примечание": "Представитель разработчика"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Изменение контрагента #

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
client_id integer (10) Да ID контрагента
parents string (255) Строка ID родителей экранированных # (последний код всегда равен ID точки контрагента)
type_id integer (10) Да ID типа контрагента (1 - Клиент(Верхний уровень клиента), 2 - Подразделение(Обычно используется для объединения клиентов в различные группы), 3 - Юридическое лицо(Магазины и т.д.), 4 - ИП Индивидуальный предприниматель, 5 - Соб. юр. лицо, 6 - Частное лицо)
manager_id integer (10) Да ID менеджера
region_id integer (10) Да ID региона
segment_id integer (10) Да ID сегмента
category string (1) Да Категория контрагнета, может принимать следующие значения: A,B,C
name string (255) Да Наименование контрагента
discount float (255) Размер скидки
comment string (255) Комментарий контрагента
inn string (50) ИНН юридического лица
kpp string (50) КПП юридического лица
okato string (50) ОКАТО юридического лица
okpo string (50) ОКПО юридического лица
position string (255) Должность
document string (255) Документ удостоверяющий личность контрагента
ogrn string (50) ОГРН юридического лица
lf_id integer (10) ID правовой формы юридического лица
city string (255) Город контрагента
code string (255) Внешний код контрагента

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

{
    "token": "unique_token_for_30_minutes",
    "client_id": 5,
    "parents": "#101##102#",
    "type_id": 3,
    "manager_id": 112,
    "region_id": 1931,
    "segment_id": 24,
    "category": "A",
    "name": "Петров А.А.",
    "discount": 10.5,
    "comment": "комментарий",
    "inn": "4363435434",
    "kpp": "56785658853",
    "okato": "2343243856780",
    "okpo": "7890754342",
    "position": "Директор",
    "document": "паспорт",
    "ogrn": "4578989045",
    "lf_id": 1,
    "city": "Москва",
    "code": "к484833"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.client.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— client_id integer (10) ID контрагента

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

{
    "request_identifier": "alphapi.client.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Client edited successfully",
    "data": {
        "client_id": 5
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Категории #

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

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

{
    "request_identifier": "alphapi.categories.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "Приоритет": "A"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 Вывод только количества строк
client_id integer 10 ID контрагента

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

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

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

{
    "request_identifier": "alphapi.clients.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 6,
                "COMMENT_ID": 143,
                "CLIENT_ID": 550,
                "Номер": 550,
                "Тип": "ООО",
                "Название": "ООО База",
                "Регион": "Москва",
                "Сегмент": "Лекарства",
                "Приоритет": "А",
                "Менеджер": "Петров П.П.",
                "Дата время": "2001-01-01 01:01:01",
                "Комментарий": "текст комментария",
                "Пользователь": "Сидоров П.С."
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "request_identifier": "alphapi.clients.contacts.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "CONTACT_ID": 101,
                "PARENT_TABLE_ID": 55,
                "PARENT_ID": 4,
                "CLIENT_ID": 34,
                "Номер": 444,
                "Тип контрагента": "Простой",
                "ПФ": "ООО",
                "Название": "ООО Аптон",
                "Регион": "Вологодская область",
                "Сегмент": "ЦФО",
                "Приоритет": "низкий",
                "Менеджер": "Иванов А.А.",
                "ФИО": "Петров Александр Иванович",
                "Должность": "Директор",
                "ДР": "",
                "Тип": "Поставщик",
                "Контакт": "тел. 83504332, почта top@sales.com",
                "Примечание": "примечание",
                "Создан": "2001-01-01 01:01:01",
                "Контакт_MASK": "",
                "Контакт_MASK_COND": ""
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Менеджеры #

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

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

{
    "request_identifier": "alphapi.managers.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "Логин": "alpha-101",
                "ФИО": "Иванов Иван Иванович",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Основная группа": "Основная группа",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Регионы #

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