Отправить данные sendData
Отправка данных по HTTP/HTTPS протоколу методом GET
Метод используется для отправки данных в сервис, для последующего сохранения в нем. В дальнейшем может быть доступна для считывания методом readData
Шаблон запроса без ключа доступа:
http://iocontrol.ru/api/sendData/{board}/{variable}/{value}
Шаблон запроса с ключом доступа:
http://iocontrol.ru/api/sendData/{board}/{variable}/{value}?key=agfdsdsgsdfdfsgsfd
| board | Название панели, длина от 5 до 20 символов, можно использовать только латиницу, цифры и символ: _ подчеркивание |
| variable | Имя переменной из указанной панели, длина от 1 до 20 символов, можно использовать только латиницу, цифры и символ: _ подчеркивания |
| value | Значение переменной, которое необходимо передать для в сервис для сохранения |
| key | Ключ доступа, в случае когда панель в режиме доступа по ключу. Приватный режим работы |
Пример запроса:
http://iocontrol.ru/api/sendData/trema/float/123.112921?key=agfdsdsgsdfdfsgsfd
Ответ в формате JSON
{
"check":true,
"value":"123.113",
"message":"",
"requestTime":"0.0061"
}check - Статут запроса. Значение true - запрос выполнен успешно, false - запрос вернул ошибку
value - Значение, которое было принято сервером в результате данного запроса и сохранено
message - Тут сервис может уведомить Вас например о характере ошибки, в случае когда check вернул false
requestTime - Время которое серверу понадобилось на обработку запроса, в секундах
Получить данные readData
Получение данных по HTTP/HTTPS протоколу методом GET.
Метод используется для чтения данных из сервиса.
Шаблон запроса без ключа доступа:
http://iocontrol.ru/api/readData/{board}/<strong>{variable}</strong>
Шаблон запроса с ключом доступа:
http://iocontrol.ru/api/readData/{board}/{variable}?key=agfdsdsgsdfdfsgsfd
| board | Название панели, длина от 5 до 20 символов, можно использовать только латиницу, цифры и символ: _ подчеркивание |
| variable | Имя переменной из указанной панели, длина от 1 до 20 символов, можно использовать только латиницу, цифры и символ: _ подчеркивания |
| key | Ключ доступа, в случае когда панель в режиме доступа по ключу. Приватный режим работы |
Пример запроса:
http://iocontrol.ru/api/sendData/trema/float?key=agfdsdsgsdfdfsgsfd
Ответ JSON
{
"check":true,
"value":"123.113",
"date":"05.01.2020 22:56:50",
"dateUnix":"1579276729",
"message":"",
"requestTime":"0.0004"
}check - Статут запроса. Значение true - запрос выполнен успешно, false - запрос вернул ошибку
value - Значение переменной, хранимое в сервисе
date - Время, когда текущие значение было записано в сервис
dateUnix - Время в Unix, когда текущие значение было записано в сервис
message - Тут сервис может уведомить Вас например р о характере ошибки, в случае когда check вернул false
requestTime - Время которое серверу понадобилось на обработку запроса, в секундах
Ошибки
Error 1001 - Не указан параметр имя панели! Длина не мене 5 символов и не более 30
Error 1002 - Не корректное имя панели! Длина не мене 5 символов и не более 30
Error 1003 - Панель с таким именем не существует или доступ к ней ограничен по ключу, передайте параметр ключ
Error 1004 - Не указан параметр имя переменной! Длина не мене 1 символов и не более 30
Error 1005 - Не корректное имя переменной! Длина не мене 1 символов и не более 30
Error 1006 - Комбинация переменной и панели не найдена
Error 1007 - Не указан параметр передаваемого значения
Error 1008 - Ошибка сохранения в БД
