Automap — rest

Automap / Руководство разработчика REST /Датчики

Датчики

Датчики определенного ТС

GET /cars/{id}/gauges

Структура запроса:


GET /cars/4357/gauges?token=bw3ty3h46yth

id: id ТС

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
	"carId": 4357,
	"glonassId": 909060,
	"port": 23,
	"name": "Название датчика",
	"categoryId": 2,
	"typeId": 41,
	"analogToDin": false,
	"din": false,
	"dinInvert": false,
	"analog": 62.0,
	"updateData": 1428327427000,
	"id": 1448,
	"analogMin": null,
	"analogMax": null,
	"analogStep": null,
	"analogAlarm": false,
	"dinAlarm": false
},...]    




// id ТС, целое число
// ГЛОНАСС id, целое число
// порт, целое число
// название датчика, строка
// id категории датчика, целое число
// id типа датчика, целое число
// аналоговый в цифровой, булевое поле
// цифровой, булевое поле
// цифровой инвертированный, булевое поле
// значение аналогового датчика, число с плавающей точкой
// дата обновления, timestamp
// id датчика, целое число
// аналоговый, с фиксацией события меньше, чем значение данного поля
// аналоговый, с фиксацией события больше, чем значение данного поля
// аналоговый, с фиксацией события при изменении шага меньше чем значение поля
// оповещение по аналоговому датчику, булевое поле
// оповещение по цифровому датчику, булевое поле

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Добавление датчика ТС

Доступно только для пользователей с правами администратора

POST /cars/{id}/gauges

Структура запроса:


POST /cars/4297/gauges?token=bw3ty3h46yth

id: id ТС

token: ключ доступа

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

{
	"categoryId": "2",
	"name": "Новый датчик",
	"unitName": "Секунды"
}


// id категории датчика, целое число
// название датчика, строка
// единица измерения, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 381,
	"name": "Новый датчик",
	"dinAlarm": false,
	"unitName": "Секунды",
	"port": null,
	"systemType": 0,
	"categoryId": 2
}


// id датчика, целое число
// название датчика, строка
// оповещение, булевое поле
// единица измерения, строка
// номер порта, целое число
// тип системы, целое число
// id категории, целое число

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Снятие датчика с ТС

Доступно только для пользователей с правами администратора

DELETE /cars/{carid}/gauges/{port}/{typeid}

Структура запроса:


DELETE /cars/59/gauges/1334/2?token=bw3ty3h46yth

carId: id ТС

port: порт

typeId: id типа

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Категории датчиков

GET /gauges/categories

Структура запроса:


GET /gauges/categories?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
		"id": 1,
		"name": "Цифровой",
		"shortName": "din"
},...]  


// id категории, целое число
// название категории, строка
// сокращенное название категории

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Типы датчиков

GET /gauges/types

Структура запроса:


GET /gauges/types?token=bw3ty3h46yth

token: ключ доступа

Параметры фильтрации


GET /gauges/types?types.port=26&dinAlarm=true

name: получение списка типов датчиков по названию

category: поиск типов датчиков, принадлежащих хотя бы одной из заданных категорий

dinAlarm: получение списка типов датчиков, являющиеся цифровыми с оповещениями или нет, в соответствии заданному булевому значению

unitName: поиск типов датчиков по названию единиц измерения

types.port: поиск типов датчиков по номеру порта

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
		"id": 2,
		"name": "Название датчика",
		"dinAlarm": false,
		"unitName": null,
		"port": null,
		"categoryId": 2
},...] 


// id типа, целое число
// название типа, строка
// цифровой с оповещением, булевое поле
// единицы измерения, строка
// порт, целое число
// id категории, целое число

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Создание датчика

Доступно только для пользователей с правами администратора

POST /gauges/types

Структура запроса:


POST /gauges/types?token=bw3ty3h46yth

token: ключ доступа

Формат: json

{
	"categoryId": 3,
	"name": "название датчика"
} 


// id категории, целое число
// название датчика, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"categoryId": 3,
	"dinAlarm": false,
	"id": 243,
	"name": "название датчика",
	"port": null,
	"unitName": null
} 


// id категории, целое число
// цифровой с оповещением, булевое поле
// id датчика, целое число
// название датчика, строка
// порт, целое число
// единицы измерения, строка 

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

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

Доступно только для пользователей с правами администратора

PUT /gauges/types/{id}

Структура запроса:


PUT /gauges/types/14?token=bw3ty3h46yth

id: id типа датчика

token: ключ доступа

Формат: json

{
	"categoryId": 4,
	"dinAlarm": false,
	"id": 243,
	"name": "test",
	"port": null,
	"unitName": null
}


// id категории, целое число
// цифровой с оповещением, булевое поле
// id датчика, целое число
// название датчика, строка
// порт, целое число
// единицы измерения, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"categoryId": 4,
	"dinAlarm": false,
	"id": 243,
	"name": "test",
	"port": null,
	"unitName": null
}


// id категории, целое число
// цифровой с оповещением, булевое поле
// id датчика, целое число
// название датчика, строка
// порт, целое число
// единицы измерения, строка

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

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

Доступно только для пользователей с правами администратора

DELETE /gauges/types/{id}

Структура запроса:


DELETE /gauges/types/3?token=bw3ty3h46yth

id: id типа датчика

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Датчики, которые выводят оповещения на экран

GET /gauges/alarm

Структура запроса:


GET /gauges/alarm?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
                "id":1,
		"unitName": null,
		"dinAlarm": true,
		"analogMin": null,
		"analogMax": null,
		"analogStep": null,
		"analogAlarm": false,
		"dinInvert": true,
		"analogToDin": false,
		"autoDisable": null,
		"disableTimeout": null,
		"disablePeriodStart": null,
		"disablePeriodEnd": null,
		"name": "название датчика",
		"port": 66,
		"carId": 4158,
		"categoryId": 1,
		"typeId": 46
},...]


// id датчика, целое число
// единица измерения, строка
// цифровой с оповещением, булевое поле
// аналоговый, с фиксацией события меньше чем значение данного поля, булевое поле
// аналоговый, с фиксацией события больше чем значение данного поля, булевое поле
// аналоговый, с фиксацией события при изменении шага меньше чем значение поля
// аналоговый с оповещением, булевое поле
// инвертировать цифровой, булевое поле
// аналоговый в цифровой, булевое поле
// автоматическое отключение, булевое поле
 
// отключить начало периода, булевое поле
// отключить конец периода, булевое поле
// название датчика, строка
// порт, целое число
// id ТС, целое число
// id категории, целое число
// id типа, целое число

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Automap — rest — gauges

Датчики

Датчики определенного ТС

GET /cars/{id}/gauges

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Добавление датчика ТС

Доступно только для пользователей с правами администратора

POST /cars/{id}/gauges

Структура запроса:

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

Ответ:

Статус: 200 — успешное выполнение

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Снятие датчика с ТС

Доступно только для пользователей с правами администратора

DELETE /cars/{carid}/gauges/{port}/{typeid}

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Категории датчиков

GET /gauges/categories

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Типы датчиков

GET /gauges/types

Структура запроса:

Параметры фильтрации

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Создание датчика

Доступно только для пользователей с правами администратора

POST /gauges/types

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

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

Доступно только для пользователей с правами администратора

PUT /gauges/types/{id}

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

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

Доступно только для пользователей с правами администратора

DELETE /gauges/types/{id}

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере

Датчики, которые выводят оповещения на экран

GET /gauges/alarm

Структура запроса:

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Статус: 500 — ошибка на сервере