AutoGRAPHServer Public API documentation version 1.12
https://tryapi.tk-chel.ru/
Описание
Настоящий документ описывает протокол управления АвтоГРАФ Сервером. Данный протокол поддерживается в АвтоГРАФ Сервер версии 5.4.6 и выше. Тестирование протокола можно производить на сервере tryapi.tk-chel.ru порт 2231. Для аутентификации укажите логин admin пароль 12345678. Данный сервер обрабатывает все запросы, кроме запросов изменения и удаления учетной записи admin.
История изменений
17.05.2022 АвтоГРАФ Сервер API V 1.12- Добавлены запросы для управления файлами полученными с приборов / предназначенные для отправки на приборы.
- Добавлены запросы счетчиков производительности диспетчерских модулей.
- Добавлен запрос настроек отправки данных в Яндекс Транспорт
- Добавлен запрос отмены размещенных команд для приборов.
- Добавлен запрос состояния сервера.
- Добавлен запрос производительности модуля приема данных.
- Добавлен запрос пересылки архивных данных
- Добавлен запрос добавления фотоснимков на сервера
21.11.2018 АвтоГРАФ Сервер API V 1.6
- Добавлен запрос сохранения файлов пользователя в локальный каталог сервера /files/get/userfiletolocaldir
- Добавлен запрос загрузки файлов пользователя из локального каталога сервера /files/add/userfilefromlocaldir
06.07.2018 АвтоГРАФ Сервер API V 1.5
- Добавлен запрос копии БД пользователей /server/get/dbcopy
07.06.2018 АвтоГРАФ Сервер API V 1.4
- Добавлен запрос встречаемости прибора userapi/get/devpopularity
16.08.2017 АвтоГРАФ Сервер API V 1.3
- Добавлены запросы управления серверами пересылки
- Добавлены запросы управления виртуальными номерами приборов
- Добавлены запросы получения статистики приема данных
- Добавлены запросы получения статистики пересылки данных
13.02.2017 АвтоГРАФ Сервер API V 1.2
- Добавлен запрос /data/setroute
09.12.2016 АвтоГРАФ Сервер API V 1.1
- Изменения в запросе данных. Добавлен virtual_id
- Во всех запросах, кроме /devices/... . device_id заменен на virtual_id
09.12.2016 АвтоГРАФ Сервер API V 1.0
- Первая версия АвтоГРАФ Сервер API
Общие сведения
Модуль поддержки API АвтоГРАФ Сервера является HTTPS сервером и обслуживает запросы на порту 2231. Данный порт может быть изменен в конфигурации АвтоГРАФ сервера. SSL сертификат сервера является обязательным. Можно использовать как самоподписанные сертификаты, так и сертификаты, выданные удостоверяющими центрами. Предоставление сертификата от клиента не требуется.
Аутентификация
АвтоГРАФ Сервер API поддерживает метод OAuth 2 для аутентификации всех запросов с некоторыми отступлениями от стандарта RFC6749. Изменения касаются метода передачи учетных данных. АвтоГРАФ Сервер требует передачи параметров в JSON теле запроса.
Для получения токена доступа необходимо отправить HTTP POST запрос на /gettoken. Для аутентификации запроса токена доступа могут быть использованы 2 метода: HTTP Basic для аутентификации по локальной базе данных, или HTTP Negotiate для аутентификации доменных пользователей. Каждый токен доступа имеет ограниченный срок службы (по умолчанию 3600 секунд). По истечении времени действия необходимо получить новый токен доступа. Для этого можно отправить запрос /refreshtoken, предоставив серверу имя пользователя и токен обновления, или пройти аутентификацию заново. При успешном обновлении токена доступа сервер возвращает новую пару токенов. Метод обновления токена является предпочтительным, т.к. в этом случае не требуется хранить пароль пользователя на стороне клиента.
Для всех последующих обращений к серверу необходимо предоставить выданный токен доступа. Токен доступа передается в заголовке Authorization.
Пример: Authorization: token B52541660DC548BC3F7D7C892E142A767E48FD08D53FAEA6D2 9A46C6A593
Каждый пользователей может создать неограниченное число одновременно действующих пар токенов доступа/обновления. При попытке использовать токен обновления повторно сервер удаляет все выданные токены доступа и обновления учетной записи. При попытке использовать токен доступа, выданный другой учетной записи, сервер удаляет все токены доступа и обновления обеих учетных записей: учетной записи, которой был выдан токен обновления и учетной записи, для которой была попытка получить токен доступа.
Таблица прав пользователей
Перечень доступных прав объекта:
RightId | Название | Описание |
---|---|---|
0 | usersedit | разрешить управление пользователями |
1 | uploadfile | Разрешить загрузку файлов на сервер |
2 | onlylastposition | разрешить только запросы по протоколу запроса последнего положения |
3 | parentdevices | Разрешить доступ ко всем приборам сервера |
4 | serveradmin | администратор сервера |
6 | attributesedit | разрешить управление атрибутами объектов |
16 | flduserread | разрешить чтение файлов, назначенных объекту |
17 | fldcamphotoread | разрешить чтение файлов из каталога CamPhoto (фотоснимки) |
18 | flddevfilesread | разрешить чтение файлов из каталога DevFiles (файлы, назначенные для отправки на приборы) |
19 | fldconfread | разрешить чтение файлов из каталога Conf (ATC файлы команд, размещенных для отправки на приборы) |
20 | fldmessagesread | разрешить чтение файлов из каталога Messages (сообщения, принятые с приборов) |
21 | fldfromdevfilesread | разрешить чтение файлов из каталога FromDevFiles (файлы, принятые с приборов) |
22 | fldforegneruserread | разрешить чтение файлов, унаследованных объектом |
24 | flduserwrite | разрешить изменение файлов, назначенных объекту |
25 | fldcamphotowrite | разрешить изменение файлов в каталоге CamPhoto (фотоснимки) |
26 | flddevfileswrite | разрешить изменение файлов в каталоге DevFiles (файлы, назначенные для отправки на приборы) |
27 | fldconfwrite | разрешить изменение файлов в каталоге Conf (ATC файлы команд, размещенных для отправки на приборы) |
28 | fldmessageswrite | разрешить изменение файлов в каталоге Messages (сообщения, принятые с приборов) |
29 | fldfromdevfileswrite | разрешить изменение файлов в каталоге FromDevFiles (файлы, принятые с приборов) |
30 | fldforegneruserwrite | разрешить изменение файлов других объектов |
32 | devglobalmanagedevices | разрешить управление обслуживаемыми приборами |
34 | devconfoperator | разрешить отправку команд на прибор |
35 | createscheme | разрешить создание новый схем |
36 | readscheme | разрешить чтение схем |
37 | writescheme | разрешить изменение схем |
38 | deletescheme | разрешить удаление схем |
39 | changerightsscheme | разрешить изменение прав доступа к схеме |
Коды результатов обработки запросов
Описание кодов результатов обработки запросов:
Result | Описание |
---|---|
ok | Запрос выполнен успешно |
disabled | Доступ отключен системой биллинга |
access_denied | Объект не доступен пользователю |
no_files | Файлов не найдено в запрашиваемом периоде |
too_much_request | Слишком большой запрос для обработки |
list_not_loaded | Список фотоснимков еще не загружен с прибора |
list_loading | Список фотоснимков в процессе загружен с прибора |
virtual_pair_failed | Виртуальный номер не связан с серийным номером прибора |
failed | Ошибка обработки запроса |
not_found | Объект не найден |
file_access_denied | Файл не доступен пользователю |
file_too_small | Размер файла не соответствует запрашиваемому (изменился в процессе обработки запроса) |
file_not_readed | Ошибка чтения файла с диска |
file_not_found | Запрашиваемый файл не найден |
object_not_defined | Не указан номер объекта в запросе |
/gettoken
Получение токена доступа к серверу
post /gettoken
АвтоГРАФ Сервер поддерживает http basic аутентификацию для получения токена доступа
АвтоГРАФ Сервер поддерживает http negotiate аутентификацию для получения токена доступа в соотеветствии со стандартом RFC4559. https://tools.ietf.org/html/rfc4559
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"access_token",
"expires_in",
"refresh_token"
],
"properties": {
"access_token": {
"type": "string",
"description": "Токен доступа к серверу."
},
"expires_in": {
"type": "integer",
"description": "Время действия токена доступа в секундах"
},
"refresh_token": {
"type": "string",
"description": "Токен для обновления докена доступа"
}
}
}
/refreshtoken
Получение нового токена доступа к серверу взамен устаревшего
post /refreshtoken
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"client_id",
"refresh_token"
],
"properties": {
"client_id": {
"type": "string",
"description": "Имя пользователя."
},
"refresh_token": {
"type": "string",
"description": "Токен продления токена доступа"
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"access_token",
"expires_in",
"refresh_token"
],
"properties": {
"access_token": {
"type": "string",
"description": "Токен доступа к серверу."
},
"expires_in": {
"type": "integer",
"description": "Время действия токена доступа в секундах"
},
"refresh_token": {
"type": "string",
"description": "Токен для обновления докена доступа"
}
}
}
Secured by
/server
Управление сервером
Получение информации о АвтоГРАФ сервере
post /server/get/info
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"description": "Версия серверного ПО"
},
"uptime": {
"type": "integer",
"description": "Время работы сервера в секундах"
},
"license_number": {
"type": "integer",
"description": "Номер лицензии серверного ПО"
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Получение настроек АвтоГРАФ сервера
post /server/get/settings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Получение списка серверов пересылки
post /server/get/transferserverlist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"address",
"port",
"format",
"status",
"redirect_all_devices"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"address": {
"type": "string",
"description": "Адрес пересылки данных"
},
"port": {
"type": "integer",
"description": "Порт сервера"
},
"format": {
"type": "integer",
"description": "Формат пересылки данных"
},
"status": {
"type": { "enum": ["enabled", "disabled", "removed", "config_fail"] },
"description": "Статус сервера пересылки"
},
"redirect_all_devices": {
"type": "boolean",
"description": "Пересылать данные всех приборов, или по списку"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Получение настроек сервера пересылки
post /server/get/transferserversettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"result"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "server_not_found", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"address": {
"type": "string",
"description": "Адрес пересылки данных"
},
"port": {
"type": "integer",
"description": "Порт сервера"
},
"format": {
"type": "integer",
"description": "Формат пересылки данных"
},
"status": {
"type": { "enum": ["enabled", "disabled", "removed", "config_fail"] },
"description": "Статус сервера пересылки"
},
"description": {
"type": "string",
"description": "Краткое описание севрера. Используется в именах файлов журнала"
},
"period": {
"type": "integer",
"description": "Инетрвал пересылки данных в секундах"
},
"redirect_all_devices": {
"type": "boolean",
"description": "Пересылать данные всех приборов, или по списку"
},
"action_url": {
"type": "string",
"description": "Action часть HTTP адреса сервероа пересылки"
},
"user_name": {
"type": "string",
"description": "Имя пользователя дл аутентификации на удаленном сервере"
},
"user_password": {
"type": "string",
"description": "Пароль пользователя дл аутентификации на удаленном сервере"
},
"serial_prefix": {
"type": "string",
"description": "Префикс серийного номера"
},
"connection_pool_size": {
"type": "integer",
"description": "Количество соединений в пуле"
},
"connection_keep_alive": {
"type": "boolean",
"description": "Поддерживать соединение с удаленным сервером"
},
"connection_use_ssl": {
"type": "boolean",
"description": "Шифрованное соединение с удаленным сервером"
},
"convert_pass_counting": {
"type": "boolean",
"description": "Отправлять данные пассажиропотока"
},
"sql_datetime_format": {
"type": "string",
"description": "Формат штампа времени для SQL пересылок"
},
"sql_export_mode": {
"type": "integer",
"description": "Метод выгрузки данных в SQL"
},
"sql_datebase_name": {
"type": "string",
"description": "Имя БД для выгрузки данных в SQL"
},
"dynamic_server": {
"type": "boolean",
"description": "Динамическая пересылка данных"
},
"dynamic_server_reason": {
"type": "integer",
"description": ""
},
"batch_size": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке"
},
"batch_size_bin": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке для данных старого формата"
},
"detailed_log": {
"type": "boolean",
"description": "Детализированный журнал пересылки"
},
"skip_bin_data": {
"type": "boolean",
"description": "Не пересылать данные приборов в старом bin формате"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Получение списка пересылаемых приборов сервера пересылки
post /server/get/transferserverdevices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"result"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Загрузка копии БД пользователей
post /server/get/dbcopy
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": { "enum": ["ok", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"db": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "БД Пользователей"
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установка настроек сервера пересылки
post /server/set/transferserversettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"address": {
"type": "string",
"description": "Адрес пересылки данных"
},
"port": {
"type": "integer",
"description": "Порт сервера"
},
"format": {
"type": "integer",
"description": "Формат пересылки данных"
},
"status": {
"type": { "enum": ["enabled", "disabled", "removed", "config_fail"] },
"description": "Статус сервера пересылки"
},
"description": {
"type": "string",
"description": "Краткое описание севрера. Используется в именах файлов журнала"
},
"period": {
"type": "integer",
"description": "Инетрвал пересылки данных в секундах"
},
"redirect_all_devices": {
"type": "boolean",
"description": "Пересылать данные всех приборов, или по списку"
},
"action_url": {
"type": "string",
"description": "Action часть HTTP адреса сервероа пересылки"
},
"user_name": {
"type": "string",
"description": "Имя пользователя дл аутентификации на удаленном сервере"
},
"user_password": {
"type": "string",
"description": "Пароль пользователя дл аутентификации на удаленном сервере"
},
"serial_prefix": {
"type": "string",
"description": "Префикс серийного номера"
},
"connection_pool_size": {
"type": "integer",
"description": "Количество соединений в пуле"
},
"connection_keep_alive": {
"type": "boolean",
"description": "Поддерживать соединение с удаленным сервером"
},
"connection_use_ssl": {
"type": "boolean",
"description": "Шифрованное соединение с удаленным сервером"
},
"convert_pass_counting": {
"type": "boolean",
"description": "Отправлять данные пассажиропотока"
},
"sql_datetime_format": {
"type": "string",
"description": "Формат штампа времени для SQL пересылок"
},
"sql_export_mode": {
"type": "integer",
"description": "Метод выгрузки данных в SQL"
},
"sql_datebase_name": {
"type": "string",
"description": "Имя БД для выгрузки данных в SQL"
},
"dynamic_server": {
"type": "boolean",
"description": "Динамическая пересылка данных"
},
"dynamic_server_reason": {
"type": "integer",
"description": ""
},
"batch_size": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке"
},
"batch_size_bin": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке для данных старого формата"
},
"detailed_log": {
"type": "boolean",
"description": "Детализированный журнал пересылки"
},
"skip_bin_data": {
"type": "boolean",
"description": "Не пересылать данные приборов в старом bin формате"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установка списка пересылаемых приборов сервера пересылки
post /server/set/transferserverdevices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"devices"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить сервер пересылки
post /server/add/transferserver
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"address": {
"type": "string",
"description": "Адрес пересылки данных"
},
"port": {
"type": "integer",
"description": "Порт сервера"
},
"format": {
"type": "integer",
"description": "Формат пересылки данных"
},
"status": {
"type": { "enum": ["enabled", "disabled", "removed", "config_fail"] },
"description": "Статус сервера пересылки"
},
"description": {
"type": "string",
"description": "Краткое описание севрера. Используется в именах файлов журнала"
},
"period": {
"type": "integer",
"description": "Инетрвал пересылки данных в секундах"
},
"redirect_all_devices": {
"type": "boolean",
"description": "Пересылать данные всех приборов, или по списку"
},
"action_url": {
"type": "string",
"description": "Action часть HTTP адреса сервероа пересылки"
},
"user_name": {
"type": "string",
"description": "Имя пользователя дл аутентификации на удаленном сервере"
},
"user_password": {
"type": "string",
"description": "Пароль пользователя дл аутентификации на удаленном сервере"
},
"serial_prefix": {
"type": "string",
"description": "Префикс серийного номера"
},
"connection_pool_size": {
"type": "integer",
"description": "Количество соединений в пуле"
},
"connection_keep_alive": {
"type": "boolean",
"description": "Поддерживать соединение с удаленным сервером"
},
"connection_use_ssl": {
"type": "boolean",
"description": "Шифрованное соединение с удаленным сервером"
},
"convert_pass_counting": {
"type": "boolean",
"description": "Отправлять данные пассажиропотока"
},
"sql_datetime_format": {
"type": "string",
"description": "Формат штампа времени для SQL пересылок"
},
"sql_export_mode": {
"type": "integer",
"description": "Метод выгрузки данных в SQL"
},
"sql_datebase_name": {
"type": "string",
"description": "Имя БД для выгрузки данных в SQL"
},
"dynamic_server": {
"type": "boolean",
"description": "Динамическая пересылка данных"
},
"dynamic_server_reason": {
"type": "integer",
"description": ""
},
"batch_size": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке"
},
"batch_size_bin": {
"type": "integer",
"description": "Максимальный размер исходных данных в 1 посылке для данных старого формата"
},
"detailed_log": {
"type": "boolean",
"description": "Детализированный журнал пересылки"
},
"skip_bin_data": {
"type": "boolean",
"description": "Не пересылать данные приборов в старом bin формате"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавление приборов в список пересылаемых приборов сервера пересылки
post /server/add/transferserverdevices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"devices"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удаление приборов из список пересылаемых приборов сервера пересылки
post /server/delete/transferserverdevices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id",
"devices"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Переслать архивные данные по приборам
post /server/transferhistory
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"server_id",
"devices"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"date_from": {
"type": "string",
"description": "Начальное время диапазона пересылки архивных данных"
},
"date_to": {
"type": "string",
"description": "Конечное время диапазона пересылки архивных данных"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"server_id",
"result"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"result": {
"type": { "enum": ["ok", "server_not_found"] },
"description": "Результат обработки запроса"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"device_id",
"result",
"files_processed",
"data_processed"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер пересылаемого прибора"
},
"result": {
"type": { "enum": ["ok", "not_processed"] },
"description": "Результат обработки запроса"
},
"files_processed": {
"type": "integer",
"description": "Количество обработанных недельных файлов"
},
"data_processed": {
"type": "integer",
"description": "Общий размер файлов данных"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
/monitor
Мониторинг состояния сервера
Запросить статистику приема данных
post /monitor/get/recvstat
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"description": "Начальное время диапазона запроса статистики"
},
"date_to": {
"type": "string",
"description": "Конечное время диапазона запроса статистики"
},
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора, для которого запрашивается детальная статистика"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора, для которого запрашивается детальная статистика"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"total_requests": {
"type": "integer",
"description": "Общее количество обработанных запросов"
},
"last_request": {
"type": "string",
"description": "Время обработки последнего запроса"
},
"last_request_result": {
"type": "integer",
"description": "Результат обработки последнего запроса"
},
"last_request_channel": {
"type": "integer",
"description": "Канал передачи данных, по которому принят последний запрос"
},
"last_request_data_type": {
"type": "integer",
"description": "Тип данных последнего запроса"
},
"last_successfully_request": {
"type": "string",
"description": "Время обработки последнего успешного запроса"
},
"last_successfully_data_request": {
"type": "string",
"description": "Время обработки последнего успешного запроса на сохранение данных"
},
"requests": {
"type": "array",
"description": "Массив для построения графика результатов обработки запросов",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"result",
"count"
],
"properties": {
"result": {
"type": "integer",
"description": "Результат обработки запроса"
},
"count": {
"type": "integer",
"description": "Количество обработанных запросов с данным результатом"
}
}
}
},
"channels": {
"type": "array",
"description": "Массив для построения графика используемых каналов передачи данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"channel",
"count"
],
"properties": {
"channel": {
"type": "integer",
"description": "Канал передачи данных"
},
"count": {
"type": "integer",
"description": "Количество запросов, полученных по данному каналу передачи данных"
}
}
}
},
"data_types": {
"type": "array",
"description": "Массив для построения графика типов данных в обработанных запросах",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"data_type",
"count"
],
"properties": {
"data_type": {
"type": "integer",
"description": "Тип данных"
},
"count": {
"type": "integer",
"description": "Количество запросов данного типа"
}
}
}
},
"interval_chart": {
"type": "array",
"description": "Массив для построения графика интервалов передачи данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"interval",
"count"
],
"properties": {
"interval": {
"type": "integer",
"description": "Интервал передачи данных в секундах"
},
"count": {
"type": "integer",
"description": "Количество запросов, переданных с данным интервалом"
}
}
}
},
"write_time_chart": {
"type": "array",
"description": "Массив для построения графика времени записи данных на диск",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"write_time",
"count"
],
"properties": {
"write_time": {
"type": "integer",
"description": "Время записи данных в миллисекундах"
},
"count": {
"type": "integer",
"description": "Количество операций записи с данным временем"
}
}
}
},
"devices": {
"type": "array",
"description": "Массив статистических данных для запрошенных приборов",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"total_requests": {
"type": "integer",
"description": "Общее количество обработанных запросов"
},
"last_request": {
"type": "string",
"description": "Время обработки последнего запроса"
},
"last_request_result": {
"type": "integer",
"description": "Результат обработки последнего запроса"
},
"last_request_channel": {
"type": "integer",
"description": "Канал передачи данных, по которому принят последний запрос"
},
"last_request_data_type": {
"type": "integer",
"description": "Тип данных последнего запроса"
},
"last_successfully_request": {
"type": "string",
"description": "Время обработки последнего успешного запроса"
},
"last_successfully_data_request": {
"type": "string",
"description": "Время обработки последнего успешного запроса на сохранение данных"
},
"requests": {
"type": "array",
"description": "Массив для построения графика результатов обработки запросов",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"result",
"count"
],
"properties": {
"result": {
"type": "integer",
"description": "Результат обработки запроса"
},
"count": {
"type": "integer",
"description": "Количество обработанных запросов с данным результатом"
}
}
}
},
"channels": {
"type": "array",
"description": "Массив для построения графика используемых каналов передачи данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"channel",
"count"
],
"properties": {
"channel": {
"type": "integer",
"description": "Канал передачи данных"
},
"count": {
"type": "integer",
"description": "Количество запросов, полученных по данному каналу передачи данных"
}
}
}
},
"data_types": {
"type": "array",
"description": "Массив для построения графика типов данных в обработанных запросах",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"data_type",
"count"
],
"properties": {
"data_type": {
"type": "integer",
"description": "Тип данных"
},
"count": {
"type": "integer",
"description": "Количество запросов данного типа"
}
}
}
},
"interval_chart": {
"type": "array",
"description": "Массив для построения графика интервалов передачи данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"interval",
"count"
],
"properties": {
"interval": {
"type": "integer",
"description": "Интервал передачи данных в секундах"
},
"count": {
"type": "integer",
"description": "Количество запросов, переданных с данным интервалом"
}
}
}
},
"write_time_chart": {
"type": "array",
"description": "Массив для построения графика времени записи данных на диск",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"write_time",
"count"
],
"properties": {
"write_time": {
"type": "integer",
"description": "Время записи данных в миллисекундах"
},
"count": {
"type": "integer",
"description": "Количество операций записи с данным временем"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить статистику пересылки данных
post /monitor/get/redirectstat
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"date_from": {
"type": "string",
"description": "Начальное время диапазона запроса статистики"
},
"date_to": {
"type": "string",
"description": "Конечное время диапазона запроса статистики"
},
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора, для которого запрашивается детальная статистика"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора, для которого запрашивается детальная статистика"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"server_id"
],
"properties": {
"server_id": {
"type": "integer",
"description": "Идентификатор сервера пересылки"
},
"total_requests": {
"type": "integer",
"description": "Общее количество операций отправки данных"
},
"last_request": {
"type": "string",
"description": "Время последней отправки данных"
},
"last_request_result": {
"type": "integer",
"description": "Результат последней отправки данных"
},
"last_success_requests": {
"type": "integer",
"description": "Количество успешных отправок данных"
},
"last_failed_requests": {
"type": "integer",
"description": "Количество отправок данных с ошибками"
},
"requests": {
"type": "array",
"description": "Массив для построения графика результатов отправки данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"result",
"count"
],
"properties": {
"result": {
"type": "integer",
"description": "Результат отправки данных"
},
"count": {
"type": "integer",
"description": "Количество обработанных запросов с данным результатом"
}
}
}
},
"send_duration_chart": {
"type": "array",
"description": "Массив для построения графика длительности отправки данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"send_duration",
"count"
],
"properties": {
"send_duration": {
"type": "integer",
"description": "Длительность отправки данных в миллисекундах"
},
"count": {
"type": "integer",
"description": "Количество отправок данных с данной длительностью"
}
}
}
},
"send_errors": {
"type": "array",
"description": "Массив приборов с ошибками отправки данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"send_result"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"send_result": {
"type": "integer",
"description": "Возникшая ошибка при последней отправке данных"
}
}
}
},
"devices": {
"type": "array",
"description": "Массив статистических данных для запрошенных приборов",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"total_requests": {
"type": "integer",
"description": "Общее количество операций отправки данных"
},
"last_request": {
"type": "string",
"description": "Время последней отправки данных"
},
"last_request_result": {
"type": "integer",
"description": "Результат последней отправки данных"
},
"requests": {
"type": "array",
"description": "Массив для построения графика результатов отправки данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"result",
"count"
],
"properties": {
"result": {
"type": "integer",
"description": "Результат отправки данных"
},
"count": {
"type": "integer",
"description": "Количество обработанных запросов с данным результатом"
}
}
}
},
"send_duration_chart": {
"type": "array",
"description": "Массив для построения графика длительности отправки данных",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"send_duration",
"count"
],
"properties": {
"send_duration": {
"type": "integer",
"description": "Длительность отправки данных в миллисекундах"
},
"count": {
"type": "integer",
"description": "Количество отправок данных с данной длительностью"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить данные производительности модуля приема данных
post /monitor/get/perfreceivemodule
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"device_module": {
"type": "object",
"properties": {
"connected_devices": {
"type": "integer",
"description": "Количество подключенных устройств"
},
"connected_devices_ag": {
"type": "integer",
"description": "Количество подключенных устройств по протоколу АвтоГРАФ"
},
"connected_devices_agtp": {
"type": "integer",
"description": "Количество подключенных устройств по протоколу АвтоГРАФ AGTP"
},
"connected_devices_redirect": {
"type": "integer",
"description": "Количество приборов, данные которых пересылаются со сторонних серверов"
},
"connected_devices_errors": {
"type": "integer",
"description": "Количество приборов с ошибкой приема данных"
},
"connections_per_minute": {
"type": "integer",
"description": "Количество установленных подключений в минуту"
},
"requests_per_second": {
"type": "integer",
"description": "Количество обработанных запросов в секунду (усреднение на 10 секундном интервале)"
},
"data_per_second": {
"type": "integer",
"description": "Размер принятых bin/sbin данных в секунду (усреднение на 10 секундном интервале)"
},
"write_time": {
"type": "integer",
"description": "Время записи данных на диск (усреднение на 10 секундном интервале)"
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить данные состояния сервера
post /monitor/get/perfsystem
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"license": {
"type": "object",
"properties": {
"created": {
"type": "string",
"description": "Дата генерации файла лицензии в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"status": {
"type": "integer",
"description": "Статус лицензии. 0 - состояние не известно, 1 - ок, 2 - 1 уровень предупреждения, 3 - 2 уровень предупреждения, 3 - заблокирована"
},
"days_remain": {
"type": "integer",
"description": "Количество дней до окончания срока действия лицензии. -1 - лицензия бессрочная"
},
"time_to_block": {
"type": "integer",
"description": "Количество секунд до предполагаемой блокировки лицензии. -1 - не предполагается блокировка лицензии"
}
}
},
"memory": {
"type": "object",
"properties": {
"working_set": {
"type": "integer",
"description": "Объем выделенной памяти процесса в байтах"
},
"page_file_usage": {
"description": "Объем выделенной виртуальной памяти (файл подкачки) процесса в байтах"
},
"peak_working_set": {
"type": "integer",
"description": "Максимальное значение объема выделенной памяти процесса в байтах"
},
"peak_page_file_usage": {
"description": "Максимальное значение объема выделенной виртуальной памяти (файл подкачки) процесса в байтах"
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить метрики производительности диспетчерского модуля версии 4
post /monitor/get/perfdispv4module
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"dispatcher_v4_module": {
"type": "object",
"properties": {
"connections_rps": {
"type": "integer",
"description": "Количество подключений в секунду"
},
"connections_rpm": {
"type": "integer",
"description": "Количество подключений в минуту"
},
"errors_rps": {
"type": "integer",
"description": "Количество подключений с ошибкой обработки в секунду"
},
"errors_rpm": {
"type": "integer",
"description": "Количество подключений с ошибкой обработки в минуту"
},
"total_request_time": {
"type": "object",
"description": "Общее время выполнения запроса",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"total_processing_time": {
"type": "object",
"description": "Время обработки запроса, включая время приема запроса и отправки ответа",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"process_request_time": {
"type": "object",
"description": "Время обработки запроса, исключая время приема запроса и отправки ответа",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"wait_for_ptocessing_time": {
"type": "object",
"description": "Время ожидания в очереди на обработку",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"read_pequest_time": {
"type": "object",
"description": "Время приема запроса",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"request_objects_count": {
"type": "object",
"description": "Количество объектов в запросе",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"request_size": {
"type": "object",
"description": "Размер запроса в байтах",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"reply_objects_count": {
"type": "object",
"description": "Количество объектов в ответе",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"reply_size": {
"type": "object",
"description": "Размер ответа в байтах",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить метрики производительности диспетчерского модуля версии 5
post /monitor/get/perfdispv5module
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"dispatcher_v4_module": {
"type": "object",
"properties": {
"connections_rps": {
"type": "integer",
"description": "Количество подключений в секунду"
},
"connections_rpm": {
"type": "integer",
"description": "Количество подключений в минуту"
},
"requests_rps": {
"type": "integer",
"description": "Количество запросов в секунду"
},
"requests_rpm": {
"type": "integer",
"description": "Количество запросов в минуту"
},
"data_api_rps": {
"type": "integer",
"description": "Количество запросов к API данных в секунду"
},
"data_api_rpm": {
"type": "integer",
"description": "Количество запросов к API данных в минуту"
},
"user_api_rps": {
"type": "integer",
"description": "Количество запросов к API пользователей в секунду"
},
"user_api_rpm": {
"type": "integer",
"description": "Количество запросов к API пользователей в минуту"
},
"file_api_rps": {
"type": "integer",
"description": "Количество запросов к API файлов в секунду"
},
"file_api_rpm": {
"type": "integer",
"description": "Количество запросов к API файлов в минуту"
},
"device_api_rps": {
"type": "integer",
"description": "Количество запросов к API приборов в секунду"
},
"device_api_rpm": {
"type": "integer",
"description": "Количество запросов к API приборов в минуту"
},
"scheme_api_rps": {
"type": "integer",
"description": "Количество запросов к API схем в секунду"
},
"scheme_api_rpm": {
"type": "integer",
"description": "Количество запросов к API схем в минуту"
},
"monitor_api_rps": {
"type": "integer",
"description": "Количество запросов к API мониторинга в секунду"
},
"monitor_api_rpm": {
"type": "integer",
"description": "Количество запросов к API мониторинга в минуту"
},
"server_api_rps": {
"type": "integer",
"description": "Количество запросов к API управления сервером в секунду"
},
"server_api_rpm": {
"type": "integer",
"description": "Количество запросов к API управления сервером в минуту"
},
"errors_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой обработки в секунду"
},
"errors_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой обработки в минуту"
},
"error_400_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой 400 в секунду"
},
"error_400_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой 400 в минуту"
},
"error_401_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой 401 в секунду"
},
"error_401_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой 401 в минуту"
},
"error_403_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой 403 в секунду"
},
"error_403_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой 403 в минуту"
},
"error_404_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой 404 в секунду"
},
"error_404_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой 404 в минуту"
},
"error_500_rps": {
"type": "integer",
"description": "Количество запросов с ошибкой 500 в секунду"
},
"error_500_rpm": {
"type": "integer",
"description": "Количество запросов с ошибкой 500 в минуту"
},
"total_request_time": {
"type": "object",
"description": "Общее время выполнения запроса",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"process_request_time": {
"type": "object",
"description": "Время обработки запроса, исключая время приема запроса и отправки ответа",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"read_pequest_time": {
"type": "object",
"description": "Время приема запроса",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"request_objects_count": {
"type": "object",
"description": "Количество объектов в запросе",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"request_size": {
"type": "object",
"description": "Размер запроса в байтах",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
},
"reply_size": {
"type": "object",
"description": "Размер ответа в байтах",
"properties": {
"max": {
"type": "integer",
"description": "Максимальное значение (за минуту)"
},
"avg": {
"type": "integer",
"description": "Среднее значение (за минуту)"
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
/userapi
Управление учетными записями пользователей
Возвращает список объектов. Если тело запроса отсутствует, или в теле запроса не указано имя пользователя/организации, сервер вернет список объектов организации, в которой находится аутентифицированный пользователь.
post /userapi/get/userlist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"properties": {
"object_name": {
"type": "string",
"description": "Имя пользователя или организации"
},
"filter_type": {
"type": { "enum": [0, 1, 32] },
"description": "Типы объектов, список которых запрашивается."
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям. При отсутствии параметра, или при recursive=false, сервер вернет только список объектов, находящихся непосредственно в запрошенной организации."
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_domain",
"object_type",
"enabled"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_domain": {
"type": "string",
"description": "Домен объекта (только для учетных записей пользователей)"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"enabled": {
"type": "boolean",
"description": "Объект активен"
},
"owner_name": {
"type": "string",
"description": "Имя родительского объекта"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает настройки объекта.
post /userapi/get/user
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"valid_from": {
"type": "string",
"description": "Начальная дата, с которой действует учетная запись, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"valid_to": {
"type": "string",
"description": "Конечная дата, до которой действует учетная запись, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"schedule": {
"type": "string",
"description": "Недельное расписание учетной записи. Представлено в виде массива из 168 элементов 1 или 0. Каждый элемент соответствует 1 часу суток."
},
"root_file_folder": {
"type": "string",
"description": "Корневой каталог организации для загрузки/выгрузки файлов."
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает права объекта. Перечень доступных прав объекта указан в начале.
post /userapi/get/rights
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"rights"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"rights": {
"type": "array",
"items": {
"type": "object",
"required": [
"right_id",
"right_state"
],
"properties": {
"right_name": {
"type": "string",
"description": "Имя объекта права"
},
"right_id": {
"type": "integer",
"description": "Идентификатор объекта права"
},
"right_state": {
"type": "integer",
"description": "Состояние объекта права: 0 - запрещен, 1 - разрешен"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован объект права"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован объект права"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает списка приборов, доступных объекту.
post /userapi/get/userdevices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"devices"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"virtual_id",
"billing_state"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"billing_state": {
"type": "integer",
"description": "Состояние биллинга для прибора: 0 - отключен, 1 - включен системой биллинга"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован прибор"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован прибор"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список групп, в которых членствует объект.
post /userapi/get/groups
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"groups"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя группы"
},
"object_type": {
"type": "integer",
"description": "Тип объекта = 32 - группа"
},
"owner_name": {
"type": "string",
"description": "Имя организации, в которой находится группа"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследовано членство в группе"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследовано членство в группе"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список членов группы.
post /userapi/get/groupmembers
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"members"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"members": {
"type": "array",
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"owner_name": {
"type": "string",
"description": "Имя организации, в которой находится объект"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследовано членство в группе"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследовано членство в группе"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список атрибутов объектов.
post /userapi/get/attributelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"get_with_values": {
"type": "boolean",
"description": "Запросить список аттрибутов вместе со значениями"
},
"names": {
"type": "array",
"description": "Массив имен атрибутов, значения которых неоходимо получить",
"required": [
"0"
],
"items": {
"type": "string"
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"attributes"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"required": [
"attribute_name"
],
"properties": {
"attribute_name": {
"type": "string",
"description": "Имя атрибута"
},
"attribute_value": {
"type": "string",
"description": "Значение атрибута"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован атрибут"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован атрибут"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает значения атрибутов объектов.
post /userapi/get/attributevalues
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"get_with_values": {
"type": "boolean",
"description": "Запросить список аттрибутов вместе со значениями"
},
"names": {
"type": "array",
"description": "Массив имен атрибутов, значения которых неоходимо получить",
"required": [
"0"
],
"items": {
"type": "string"
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"attributes"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"required": [
"attribute_name"
],
"properties": {
"attribute_name": {
"type": "string",
"description": "Имя атрибута"
},
"attribute_value": {
"type": "string",
"description": "Значение атрибута"
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован атрибут"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован атрибут"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список объектов, которые имеют доступ к прибору.
post /userapi/get/devpopularity
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить новый объект.
post /userapi/add/user
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_domain": {
"type": "string",
"description": "Имя домена (для учетной записи пользователя)"
},
"object_password": {
"type": "string",
"description": "Пароль (для учетной записи пользователя)"
},
"object_password_compatible": {
"type": "boolean",
"description": "Хранить пароль в старом формате для совместимости с АвтоГРАФ 4.х"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"object_owner": {
"type": "string",
"description": "Имя организации, в которой необходимо создать объект"
},
"root_file_folder": {
"type": "string",
"description": "Корневой каталог организации для загрузки/выгрузки файлов."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить атрибуты объектов.
post /userapi/add/attributevalues
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"attributes"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1] },
"description": "Тип объекта. 0 - пользователь, 1 - организация"
},
"attributes": {
"type": "array",
"description": "Массив атрибутов",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"attribute_name": {
"type": "string",
"description": "Имя атрибута"
},
"attribute_value": {
"type": "string",
"description": "Значение атрибута"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Создать токен WEB сервера.
post /userapi/add/webtoken
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": { "enum": ["ok", "failed"] },
"description": "Результат выполнения запроса"
},
"access_token": {
"type": "string",
"description": "Токен доступа к серверу."
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Создать токен WEB сервера.
post /userapi/add/readonlywebtoken
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": { "enum": ["ok", "failed"] },
"description": "Результат выполнения запроса"
},
"access_token": {
"type": "string",
"description": "Токен доступа к серверу."
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить объект.
post /userapi/delete/user
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"recursive": {
"type": "boolean",
"description": "Выполнить запрос рекурсивно по всем вложенным организациям."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удаляет атрибуты объектов.
post /userapi/delete/attributevalues
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
},
"get_with_values": {
"type": "boolean",
"description": "Запросить список аттрибутов вместе со значениями"
},
"names": {
"type": "array",
"description": "Массив имен атрибутов, значения которых неоходимо получить",
"required": [
"0"
],
"items": {
"type": "string"
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить настройки объекта.
post /userapi/set/user
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"object_domain"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта, настройки которого необходимо изменить"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, настройки которого необходимо изменить"
},
"object_new_name": {
"type": "string",
"description": "Новое имя объекта"
},
"enabled": {
"type": "boolean",
"description": "Учетная запись включена"
},
"object_password": {
"type": "string",
"description": "Новый пароль (для учетной записи пользователя)"
},
"object_password_compatible": {
"type": "boolean",
"description": "Хранить пароль в старом формате для совместимости с АвтоГРАФ 4.х"
},
"object_domain": {
"type": "string",
"description": "Имя домена (для учетной записи пользователя)"
},
"valid_from": {
"type": "string",
"description": "Начальная дата, с которой действует учетная запись, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"valid_to": {
"type": "string",
"description": "Конечная дата, до которой действует учетная запись, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"schedule": {
"type": "string",
"description": "Недельное расписание учетной записи. Представлено в виде массива из 168 элементов 1 или 0. Каждый элемент соответствует 1 часу суток."
},
"root_file_folder": {
"type": "string",
"description": "Корневой каталог организации для загрузки/выгрузки файлов."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить права объекта.
post /userapi/set/rights
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"rights"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"rights": {
"type": "array",
"items": {
"type": "object",
"required": [
"right_id",
"right_state"
],
"properties": {
"right_id": {
"type": "integer",
"description": "Идентификатор объекта права"
},
"right_state": {
"type": "integer",
"description": "Состояние объекта права: 0 - запрещен, 1 - разрешен"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить список приборов, доступных объекту.
post /userapi/set/devices
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"devices"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"virtual_id",
"billing_state"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"billing_state": {
"type": "integer",
"description": "Состояние биллинга для прибора: 0 - отключен, 1 - включен системой биллинга"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить список членов группы.
post /userapi/set/groupmembers
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"members"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"members": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "string",
"description": "Имя группы, членом которой является объект"
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить список групп, членом которых является объект.
post /userapi/set/groups
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"groups"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"groups": {
"type": "array",
"description": "Массив",
"required": [
"0"
],
"items": {
"type": "string",
"description": "Имя группы, членом которой является объект"
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "ou_not_found", "already_exist", "wrong_data", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
/files
Управление файлами
Возвращает список доступных файлов объекта.
post /files/get/userfilelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта. 0 - пользователь, 1 - организация, 32 - группа"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "already_exist", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован файл"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован файл"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список файлов, принятых с прибора.
post /files/get/devinfilelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список файлов, назначенных для отправки на прибор.
post /files/get/devoutfilelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список файлов сообщений, принятых с прибора.
post /files/get/devmessagefilelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает список фотоснимков.
post /files/get/devshotlist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"shot_location"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shot_location": {
"type": { "enum": ["server", "devlocal", "devremote"] },
"description": "Расположение снимков. Сервер, АвтоГРАФ или внешнее устройство (АвтоГРАФ Инфо)"
},
"date_from": {
"type": "string",
"description": "Начальная дата запроса списка фотоснимков в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"date_to": {
"type": "string",
"description": "Конечная дата запроса списка фотоснимков в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"shot_location",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shot_location": {
"type": { "enum": ["server", "devlocal", "devremote"] },
"description": "Расположение снимков: локальные или на внешнем устройстве (АвтоГРАФ Инфо)"
},
"result": {
"type": { "enum": ["ok", "access_denied", "list_loading","list_not_loaded", "device_not_replied", "device_not_connected"] },
"description": "Результат обработки запроса"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"display_serial",
"camera_address",
"shot_number",
"shot_size",
"shot_date",
"shot_progress",
"shot_status"
],
"properties": {
"display_serial": {
"type": "integer",
"description": "Серийный номер устройства, создавшего снимок"
},
"camera_address": {
"type": "integer",
"description": "Адрес камеры"
},
"shot_number": {
"type": "integer",
"description": "Номер снимка"
},
"shot_size": {
"type": "integer",
"description": "Размер снимка"
},
"shot_date": {
"type": "string",
"description": "Дата и время создания снимка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"shot_progress": {
"type": "integer",
"description": "Прогресс загрузки снимка"
},
"shot_status": {
"type": { "enum": ["shot_not_loaded", "shot_scheduled", "shot_loading", "shot_loaded"] },
"description": "Статуc загрузки снимка"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает содержимое файлов объекта.
post /files/get/userfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"files"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "already_exist", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_crc16"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован файл"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован файл"
},
"file_status": {
"type": { "enum": ["ok", "file_not_readed", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "already_exist", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_crc16"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован файл"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован файл"
},
"file_status": {
"type": { "enum": ["ok", "file_not_readed", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Сохранить файлы объекта в каталог сервера. Если каталог не задан в запросе, файлы сохраняются в каталог заданный в настройках организации.
post /files/get/userfiletolocaldir
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"files"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"local_root_folder": {
"type": "string",
"description": "Локальный каталог для сохранения файлов"
},
"overwrite_existing": {
"type": "boolean",
"description": "Перезаписывать существующие файлы"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "already_exist", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_crc16"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован файл"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован файл"
},
"file_status": {
"type": { "enum": ["ok", "file_not_readed", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "already_exist", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_crc16"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"inherited_name": {
"type": "string",
"description": "Имя объекта, от которого унаследован файл"
},
"inherited_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта, от которого унаследован файл"
},
"file_status": {
"type": { "enum": ["ok", "file_not_readed", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает содержимое файлов, принятых с прибора.
post /files/get/devinfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"files"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает содержимое файлов, назначенных для отправки на прибор.
post /files/get/devoutfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"files"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает содержимое atc файлов каталога Conf прибора.
post /files/get/devconffile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"files"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает содержимое файлов сообщений, принятых с прибора.
post /files/get/devmessagefile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"files"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла для загрузки"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого необходимо загрузить файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_hash"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_size": {
"type": "integer",
"description": "Размер файла"
},
"file_date": {
"type": "string",
"description": "Дата модификации файла в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"file_hash": {
"type": "string",
"description": "SHA1 хэш содержимого файла."
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Возвращает файлы фотоснимков.
post /files/get/devshotfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"shot_location"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shot_location": {
"type": { "enum": ["server", "devlocal", "devremote"] },
"description": "Расположение снимков: локальные или на внешнем устройстве (АвтоГРАФ Инфо)"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"display_serial",
"camera_address",
"shot_number",
"shot_date"
],
"properties": {
"display_serial": {
"type": "integer",
"description": "Серийный номер устройства, создавшего снимок"
},
"camera_address": {
"type": "integer",
"description": "Адрес камеры"
},
"shot_number": {
"type": "integer",
"description": "Номер снимка"
},
"shot_date": {
"type": "string",
"description": "Дата и время создания снимка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"shot_location"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shot_location": {
"type": { "enum": ["server", "devlocal", "devremote"] },
"description": "Расположение снимков: локальные или на внешнем устройстве (АвтоГРАФ Инфо)"
},
"result": {
"type": { "enum": ["ok", "access_denied", "list_not_loaded", "device_not_replied", "device_not_connected"] },
"description": "Результат обработки запроса"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"display_serial",
"camera_address",
"shot_number",
"shot_date",
"shot_progress",
"shot_status"
],
"properties": {
"display_serial": {
"type": "integer",
"description": "Серийный номер устройства, создавшего снимок"
},
"camera_address": {
"type": "integer",
"description": "Адрес камеры"
},
"shot_number": {
"type": "integer",
"description": "Номер снимка"
},
"shot_date": {
"type": "string",
"description": "Дата и время создания снимка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"shot_progress": {
"type": "integer",
"description": "Прогресс загрузки снимка"
},
"shot_status": {
"type": { "enum": ["ok", "shot_not_loaded", "shot_scheduled", "shot_loading", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"shot_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла снимка"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"shot_location"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shot_location": {
"type": { "enum": ["server", "devlocal", "devremote"] },
"description": "Расположение снимков: локальные или на внешнем устройстве (АвтоГРАФ Инфо)"
},
"result": {
"type": { "enum": ["ok", "access_denied", "list_not_loaded", "device_not_replied", "device_not_connected"] },
"description": "Результат обработки запроса"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"display_serial",
"camera_address",
"shot_number",
"shot_date",
"shot_progress",
"shot_status"
],
"properties": {
"display_serial": {
"type": "integer",
"description": "Серийный номер устройства, создавшего снимок"
},
"camera_address": {
"type": "integer",
"description": "Адрес камеры"
},
"shot_number": {
"type": "integer",
"description": "Номер снимка"
},
"shot_date": {
"type": "string",
"description": "Дата и время создания снимка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"shot_progress": {
"type": "integer",
"description": "Прогресс загрузки снимка"
},
"shot_status": {
"type": { "enum": ["ok", "shot_not_loaded", "shot_scheduled", "shot_loading", "file_not_found", "file_access_denied"] },
"description": "Результат обработки запроса"
},
"shot_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла снимка"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Загрузить новый файл для объекта.
post /files/add/userfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type",
"files"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"files": {
"type": "array",
"description": "Массив запросов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_content"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого загружается файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
},
"file_complete": {
"type": "boolean",
"description": "Файл загружен полностью"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Загрузить новый файл для объекта из каталога на сервере. Если каталог не указан в запросе, файлы загружаются из каталога, указанного в настройках организации. Если список файлов отсутствует в запросе, будут загружены все файлы из каталога.
post /files/add/userfilefromlocaldir
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"local_root_folder": {
"type": "string",
"description": "Локальный каталог, из которого загружаются файлы"
},
"files": {
"type": "array",
"description": "Массив запросов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"file_complete"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_complete": {
"type": "boolean",
"description": "Файл загружен полностью"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Загрузить новый файл в каталог файлов для отправки на прибор.
post /files/add/devoutfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"file_size",
"file_date",
"file_content"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"file_offset": {
"type": "integer",
"description": "Начальное смещение, с которого загружается файл"
},
"file_size": {
"type": "integer",
"description": "Размер загружаемой части файла"
},
"file_content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла"
},
"file_complete": {
"type": "boolean",
"description": "Файл загружен полностью"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить фотоснимки на сервер.
post /files/add/devshotfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"file_name",
"content"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла снимка"
},
"content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла снимка"
}
}
}
}
}
}
}
}
}
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"file_name",
"content"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла снимка"
},
"content": {
"type": "string",
"media": {
"binaryEncoding": "base64",
"type": "application/octet-stream"
},
"description": "Содержимое файла снимка"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла снимка"
},
"result": {
"type": { "enum": ["ok", "already_exists", "file_write_error"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/bson
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"shots": {
"type": "array",
"description": "Массив снимков",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла снимка"
},
"result": {
"type": { "enum": ["ok", "already_exists", "file_write_error"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Переместить или переименовать файл объекта.
post /files/move/userfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"files": {
"type": "array",
"description": "Массив запросов на переименование или перемещение файлов",
"items": {
"type": "object",
"required": [
"file_name",
"new_file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"new_file_name": {
"type": "string",
"description": "Новое имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Переместить или переименовать файл в каталоге, назначенных для отправки на прибор.
post /files/move/devoutfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на переименование или перемещение файлов",
"items": {
"type": "object",
"required": [
"file_name",
"new_file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"new_file_name": {
"type": "string",
"description": "Новое имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить файл объекта.
post /files/delete/userfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"object_type"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"object_type": {
"type": { "enum": [0, 1, 32] },
"description": "Тип объекта"
},
"files": {
"type": "array",
"description": "Массив запросов на удаление файлов",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"object_name",
"result"
],
"properties": {
"object_name": {
"type": "string",
"description": "Имя объекта"
},
"result": {
"type": { "enum": ["ok", "user_not_found", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить файл в каталоге принятых с прибора файлов.
post /files/delete/devinfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на удаление файлов",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить файл в каталоге, назначенных для отправки на прибор.
post /files/delete/devoutfile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на удаление файлов",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить файл в каталоге Conf прибора.
post /files/delete/devconffile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на удаление файлов",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить файл в каталоге сообщений, принятых с прибора.
post /files/delete/devmessagefile
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"files": {
"type": "array",
"description": "Массив запросов на удаление файлов",
"items": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
HTTP status code 403
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"objects"
],
"properties": {
"objects": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"files": {
"type": "array",
"description": "Массив ответов на загрузку файлов",
"items": {
"type": "object",
"required": [
"file_name",
"result"
],
"properties": {
"file_name": {
"type": "string",
"description": "Имя файла"
},
"result": {
"type": { "enum": ["ok", "file_access_denied", "file_write_error"] },
"description": "Результат обработки файла"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
/devices
Управление приборами
Запросить список обслуживаемых приборов.
post /devices/get/devicelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"imei": {
"type": "string",
"description": "imei прибора"
},
"device_state": {
"type": { "enum": ["not_serviced", "serviced_hardware", "serviced_redirect", "serviced_wifi", "serviced_free_device"] },
"description": "Статус обслуживания прибора сервером"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить список обслуживаемых приборов вместе с настройками.
post /devices/get/devicelistwithsettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"imei": {
"type": "string",
"description": "imei прибора"
},
"load_local_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM"
},
"load_remote_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM ИНФО"
},
"alarm_input": {
"type": "integer",
"description": "Номер цифрового входа, к которому подключена тревожная кнопка"
},
"alarm_level": {
"type": "integer",
"description": "Активный уровень тревожного входа. 0 - масса, 1 - бортовая сеть"
},
"yandex_transport_export": {
"type": "boolean",
"description": "Включение экспорта данных терминала в систему Яндекс Транспорт"
},
"yandex_transport_vehicle_type": {
"type": "integer",
"description": "Тип транспортного средства"
},
"yandex_transport_route": {
"type": "string",
"description": "Номер маршрута"
},
"readonly_mode": {
"type": "boolean",
"description": "Включение режима работы прибора \"только чтение\". В данном режиме запрещен прием данных с прибора."
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить состояние приборов.
post /devices/get/devicestatus
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"serviced",
"atg_exist",
"license_exist"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": [ "ok", "access_denied", "object_not_defined", "not_found", "virtual_pair_failed" ]
},
"description": "Результат обработки запроса"
},
"serviced": {
"type": "boolean",
"description": "Прибор обслуживается на сервере"
},
"atg_exist": {
"type": "boolean",
"description": "Наличие ATG файла прибора на сервере"
},
"atg_file_name": {
"type": "string",
"description": "Список ATG файлов, разделенных ';', в которых встречается данный прибор"
},
"license_exist": {
"type": "boolean",
"description": "Наличие номера прибора в лицензии"
},
"last_recieve_time": {
"type": "string",
"description": "Время последней передачи данных на сервер в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"min_write_data_time": {
"type": "integer",
"description": "Минимальное время записи данных на диск в мсек."
},
"avg_write_data_time": {
"type": "integer",
"description": "Среднее время записи данных на диск в мсек."
},
"max_write_data_time": {
"type": "integer",
"description": "Максимальное время записи данных на диск в мсек."
},
"password": {
"type": "string",
"description": "Пароль прибора на сервере"
},
"connected": {
"type": "boolean",
"description": "Наличие установленного соединения от прибора в данный момент"
},
"history_sending": {
"type": "boolean",
"description": "true - Прибор передает историю"
},
"data_receive_status": {
"type": { "enum": ["ok", "ok_repeat_data", "not_serviced", "password_mismatch", "wrong_channel", "write_error"] },
"description": "Результат последней передачи данных на сервер"
},
"device_firmware": {
"type": "string",
"description": "Версия прошивки прибора"
},
"loader_firmware": {
"type": "string",
"description": "Версия загрузчика прибора"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить настройки приборов.
post /devices/get/devicesettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"imei": {
"type": "string",
"description": "imei прибора"
},
"load_local_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM"
},
"load_remote_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM ИНФО"
},
"alarm_input": {
"type": "integer",
"description": "Номер цифрового входа, к которому подключена тревожная кнопка"
},
"alarm_level": {
"type": "integer",
"description": "Активный уровень тревожного входа. 0 - масса, 1 - бортовая сеть"
},
"yandex_transport_export": {
"type": "boolean",
"description": "Включение экспорта данных терминала в систему Яндекс Транспорт"
},
"yandex_transport_vehicle_type": {
"type": "integer",
"description": "Тип транспортного средства"
},
"yandex_transport_route": {
"type": "string",
"description": "Номер маршрута"
},
"readonly_mode": {
"type": "boolean",
"description": "Включение режима работы прибора \"только чтение\". В данном режиме запрещен прием данных с прибора."
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить настройки отправки данных в Яндекс Транспорт.
post /devices/get/yatrsettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied"] },
"description": "Результат обработки запроса"
},
"yandex_transport_export": {
"type": "boolean",
"description": "Включение экспорта данных терминала в систему Яндекс Транспорт"
},
"yandex_transport_vehicle_type": {
"type": "integer",
"description": "Тип транспортного средства"
},
"yandex_transport_route": {
"type": "string",
"description": "Номер маршрута"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить список конфигурационных команд
post /devices/get/commandrequests
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"date_from": {
"type": "string",
"description": "Дата, с которой вернуть список комманд, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"date_to": {
"type": "string",
"description": "Дата, по которую вернуть список комманд, в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"result"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"description": "Результат обработки запроса",
"type": {
"enum": [ "ok", "object_not_defined", "access_denied", "not_processed"]
}
},
"queries": {
"type": "array",
"description": "Массив запросов",
"items": {
"type": "object",
"required": [
"query_id",
"created",
"source",
"result"
],
"properties": {
"query_id": {
"type": "integer",
"description": "Номер запроса"
},
"created": {
"type": "string",
"description": "Дата и время размещения команды в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"source": {
"description": "Источник запроса",
"type": {
"anyOf": [{
"const": "api",
"title": "Команда добавлена через API запрос"
},
{
"const": "atc_file",
"title": "Команда добавлена через atc файл"
},
{
"const": "photo_manager",
"title": "Команда добавлена менеджером загрузки фотоснимков"
},
{
"const": "rdr_transnavi",
"title": "Команда добавлена пересылкой в протоколе Транснавигация"
},
{
"const": "scheduler",
"title": "Команда добавлена планировщиком"
},
{
"const": "unknown",
"title": "Неизвестный источник команды"
}
]
}
},
"file_name": {
"type": "string",
"description": "Имя atc файла, из которого добавлена команда"
},
"user_name": {
"type": "string",
"description": "Имя пользователя, добавившего команду через API"
},
"query": {
"type": "string",
"description": "Текст команды"
},
"status": {
"description": "Состояние обработки команды",
"type": {
"anyOf": [
{
"const": "waiting_for_device",
"title": "Команда не отправлена, ожидание подключения прибора"
},
{
"const": "processing",
"title": "Команда отправлена на прибор, ожидание подтверждения обработки"
},
{
"const": "completed",
"title": "Обработка команды завершера"
}
]
}
},
"result": {
"description": "Результат обработки команды",
"type": {
"anyOf": [
{
"const": "ok",
"title": "Команда успешно обработана"
},
{
"const": "busy",
"title": "Прибор занят, или занято подключенное к прибору устройство, для которого предназначена команда"
},
{
"const": "wrong_format",
"title": "Неверный формат команды"
},
{
"const": "wrong_channel",
"title": "Неверный канал передачи данных, по которому отправлена команда"
},
{
"const": "reject",
"title": "Прибор отклонил выполнение команды"
},
{
"const": "locked",
"title": "Прибор защищен от изменения настроек"
},
{
"const": "do_not_reply",
"title": "Прибор не ответил на команду после трех попыток"
},
{
"const": "unknown",
"title": "От прибора получен неизвестный результат обработки"
}
]
}
},
"reply": {
"type": "string",
"description": "Ответ прибора на команду"
},
"reply_date": {
"type": "string",
"description": "Дата и время обработки команды в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить статус обработки команды прибором.
post /devices/get/commandrequeststatus
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"queries": {
"type": "array",
"description": "Массив идентификаторов запросов",
"items": {
"type": "object",
"required": [
"query_id"
],
"properties": {
"query_id": {
"type": "integer",
"description": "Идентификатор запроса"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"result"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"queries": {
"type": "array",
"description": "Массив запросов",
"items": {
"type": "object",
"required": [
"query_id",
"result"
],
"properties": {
"query_id": {
"type": "integer",
"description": "Номер запроса"
},
"result": {
"type": { "enum": ["ok", "query_not_found", "not_processed"] },
"description": "Результат обработки"
},
"commands": {
"type": "array",
"description": "Массив команд",
"items": {
"type": "object",
"required": [
"query",
"status"
],
"properties": {
"query": {
"type": "string",
"description": "Текст команды"
},
"status": {
"type": { "enum": ["waiting_for_device", "processing", "completed"] },
"description": "Состояние обработки команды"
},
"result": {
"type": { "enum": ["ok", "busy", "wrong_format", "wrong_channel", "reject", "locked", "do_not_reply", "unknown"] },
"description": "Результат обработки команды"
},
"reply": {
"type": "string",
"description": "Ответ прибора"
},
"reply_date": {
"type": "string",
"description": "Дата и время обработки команды в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить последние данные по прибору.
post /devices/get/lastdata
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"result"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "unknown_position"] },
"description": "Результат обработки запроса"
},
"gps_position": {
"type": "object",
"description": "Последняя позиция.",
"required": [
"receive_time",
"position_time",
"latitude",
"longitude"
],
"properties": {
"receive_time": {
"type": "string",
"description": "Время получения позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"position_time": {
"type": "string",
"description": "Время позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"latitude": {
"type": "number",
"description": "Широта в градусах"
},
"longitude": {
"type": "number",
"description": "Долгота в градусах"
},
"position_source": {
"description": "Источник определения позиции",
"type": "string",
"enum": [
"gps",
"glonass",
"joint"
]
},
"receiver_source": {
"description": "Тип приемника",
"type": "string",
"enum": [
"internal",
"external"
]
},
"speed": {
"type": "integer",
"description": "Скорость движения в км/ч"
},
"azimuth": {
"type": "integer",
"description": "Направление движения"
},
"altitude": {
"type": "integer",
"description": "Высота над уровнем моря в метрах"
},
"analog_data_recieved": {
"type": "string",
"description": "Время приема аналоговых данных в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"main_power_source": {
"type": "number",
"description": "Напряжение основного источника питания"
},
"reserv_power_source": {
"type": "number",
"description": "Напряжение резервного источника питания"
},
"ain1": {
"type": "integer",
"description": "Показания 1 аналогового входа"
},
"ain2": {
"type": "integer",
"description": "Показания 2 аналогового входа"
}
}
},
"valid_gps_position": {
"type": "object",
"description": "Последняя валидная позиция. Передается при невалидной текущей позиции.",
"required": [
"receive_time",
"position_time",
"latitude",
"longitude"
],
"properties": {
"receive_time": {
"type": "string",
"description": "Время получения позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"position_time": {
"type": "string",
"description": "Время позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"latitude": {
"type": "number",
"description": "Широта в градусах"
},
"longitude": {
"type": "number",
"description": "Долгота в градусах"
},
"speed": {
"type": "integer",
"description": "Скорость движения в км/ч"
},
"azimuth": {
"type": "integer",
"description": "Направление движения"
},
"altitude": {
"type": "integer",
"description": "Высота над уровнем моря в метрах"
},
"analog_data_recieved": {
"type": "string",
"description": "Время приема аналоговых данных в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"main_power_source": {
"type": "number",
"description": "Напряжение основного источника питания"
},
"reserv_power_source": {
"type": "number",
"description": "Напряжение резервного источника питания"
},
"ain1": {
"type": "integer",
"description": "Показания 1 аналогового входа"
},
"ain2": {
"type": "integer",
"description": "Показания 2 аналогового входа"
}
}
},
"lbs_position": {
"type": "object",
"description": "Позиция, определенная по вышкам сотовой связи. Передается при невалидной текущей позиции.",
"required": [
"receive_time",
"position_time",
"latitude",
"longitude"
],
"properties": {
"receive_time": {
"type": "string",
"description": "Время получения позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"position_time": {
"type": "string",
"description": "Время позиции в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"latitude": {
"type": "number",
"description": "Широта в градусах"
},
"longitude": {
"type": "number",
"description": "Долгота в градусах"
},
"precision": {
"type": "integer",
"description": "Точность определения позиции в метрах"
},
"speed": {
"type": "integer",
"description": "Скорость движения в км/ч"
},
"azimuth": {
"type": "integer",
"description": "Направление движения"
},
"altitude": {
"type": "integer",
"description": "Высота над уровнем моря в метрах"
},
"analog_data_recieved": {
"type": "string",
"description": "Время приема аналоговых данных в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
},
"main_power_source": {
"type": "number",
"description": "Напряжение основного источника питания"
},
"reserv_power_source": {
"type": "number",
"description": "Напряжение резервного источника питания"
},
"ain1": {
"type": "integer",
"description": "Показания 1 аналогового входа"
},
"ain2": {
"type": "integer",
"description": "Показания 2 аналогового входа"
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Запросить список виртуальных номеров
post /devices/get/virtualdevicelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить настройки прибора
post /devices/set/devicesettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"imei": {
"type": "string",
"description": "imei прибора"
},
"load_local_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM"
},
"load_remote_photo": {
"type": "boolean",
"description": "Автоматически загружать планировщиком списки снимков с АвтоГРАФ GSM ИНФО"
},
"alarm_input": {
"type": "integer",
"description": "Номер цифрового входа, к которому подключена тревожная кнопка"
},
"alarm_level": {
"type": "integer",
"description": "Активный уровень тревожного входа. 0 - масса, 1 - бортовая сеть"
},
"yandex_transport_export": {
"type": "boolean",
"description": "Включение экспорта данных терминала в систему Яндекс Транспорт"
},
"yandex_transport_vehicle_type": {
"type": "integer",
"description": "Тип транспортного средства"
},
"yandex_transport_route": {
"type": "string",
"description": "Номер маршрута"
},
"readonly_mode": {
"type": "boolean",
"description": "Включение режима работы прибора \"только чтение\". В данном режиме запрещен прием данных с прибора."
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"result": {
"type": { "enum": ["ok", "ok_not_licensed", "object_not_defined", "access_denied", "atg_file_not_found", "virtual_pair_failed", "wrong_virtual_number", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить настройки отправки данных в Яндекс Транспорт
post /devices/set/yatrsettings
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"yandex_transport_export": {
"type": "boolean",
"description": "Включение экспорта данных терминала в систему Яндекс Транспорт"
},
"yandex_transport_vehicle_type": {
"type": "integer",
"description": "Тип транспортного средства"
},
"yandex_transport_route": {
"type": "string",
"description": "Номер маршрута"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"result": {
"type": { "enum": ["ok", "ok_not_licensed", "object_not_defined", "access_denied", "atg_file_not_found", "virtual_pair_failed", "wrong_virtual_number", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Установить список виртуальных номеров
post /devices/set/virtualdevicelist
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": { "enum": ["ok", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить приборы на обсуживание.
post /devices/add/device
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"imei": {
"type": "string",
"description": "imei прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"result": {
"type": { "enum": ["ok", "ok_not_licensed", "object_not_defined", "access_denied", "atg_file_not_found", "virtual_pair_failed", "wrong_virtual_number", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Добавить команду для прибора.
post /devices/add/commandrequest
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"commands": {
"type": "array",
"description": "Массив команд",
"items": {
"type": "object",
"required": [
"command"
],
"properties": {
"command": {
"type": "string",
"description": "Команда для прибора"
},
"ttl": {
"type": "integer",
"description": "Время жизни команды после размещения в секундах."
},
"delayed_till": {
"type": "string",
"description": "Отложить выполнение команды. Время в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"result"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"query_id": {
"type": "integer",
"description": "Номер запроса для проверки статуса"
},
"commands": {
"type": "array",
"description": "Массив команд",
"items": {
"type": "object",
"required": [
"command",
"result"
],
"properties": {
"command": {
"type": "string",
"description": "Команда для прибора"
},
"result": {
"type": { "enum": ["ok", "unsupported"] },
"description": "Результат обработки команды"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Снять прибор с обсуживания.
post /devices/delete/device
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"permanent": {
"type": "boolean",
"description": "Снять с обслуживания и удалить прибор"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"result": {
"type": { "enum": ["ok", "ok_not_licensed", "object_not_defined", "access_denied", "atg_file_not_found", "virtual_pair_failed", "wrong_virtual_number", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Удалить виртуальный номер
post /devices/delete/virtualdevice
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"virtual_id"
],
"properties": {
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"result"
],
"properties": {
"result": {
"type": { "enum": ["ok", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Отменить размещенные ранее команды
post /devices/delete/commandrequest
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"queries": {
"type": "array",
"description": "Массив идентификаторов запросов",
"items": {
"type": "object",
"required": [
"query_id"
],
"properties": {
"query_id": {
"type": "integer",
"description": "Идентификатор запроса"
}
}
}
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id",
"result"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"virtual_id": {
"type": "integer",
"description": "Виртуальный номер прибора"
},
"result": {
"type": { "enum": ["ok", "object_not_defined", "access_denied", "not_processed"] },
"description": "Результат обработки запроса"
},
"queries": {
"type": "array",
"description": "Массив запросов",
"items": {
"type": "object",
"required": [
"query_id",
"result"
],
"properties": {
"query_id": {
"type": "integer",
"description": "Номер запроса"
},
"result": {
"type": { "enum": ["ok", "query_not_found", "not_processed"] },
"description": "Результат обработки"
}
}
}
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.
Сбросить пароль прибора.
post /devices/resetpassword/device
АвтоГРАФ Сервер поддерживает OAuth 2 для аутентификации всех API запросов.
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"permanent": {
"type": "boolean",
"description": "Снять с обслуживания и удалить прибор"
}
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"required": [
"0"
],
"items": {
"type": "object",
"required": [
"device_id"
],
"properties": {
"device_id": {
"type": "integer",
"description": "Серийный номер прибора"
},
"result": {
"type": { "enum": ["ok", "ok_not_licensed", "object_not_defined", "access_denied", "atg_file_not_found", "virtual_pair_failed", "wrong_virtual_number", "not_processed"] },
"description": "Результат обработки запроса"
}
}
}
}
}
}
Secured by oauth_2_0
Headers
- Authorization: (string)
Используется для предоставления валидного токена доступа OAuth 2.
HTTP status code 401
Предоставлен неверный токен или токен с истекшим сроком дуйствия. Так-же может возникнуть при попытке повторного использования токена обновления. Необходимо запросить обновление токена доступа или пройти повторную аутентификацию пользователя.
HTTP status code 403
Отсутствует разрешение на выполнение запрошенной операции.