You are here: Home / 2015 / Январь / 26 / AutoMap — rest — receivers

AutoMap — rest — receivers

26 января 2015 admin
назад
mapSurfer GS / Руководство разработчика REST / Источники сбора данных

GET /daemon/receivers

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


GET /daemon/receivers?token=mbs90lon2a8

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

Ответ:

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

Формат: json


[{
	"id": 1,
	"host": "85.19.44.78",
	"port": 9912,
	"login": "login",
	"password": "password",
	"reconnectTime": 5,
	"useEnginePort": false,
	"defaultEnginePort": null,
	"timezone": 0,
	"useDinGauges": false,
	"useDinAdditionalGauges": false,
	"useAnalogGauges": false,
	"useSpeedGauge": false,
	"name": "Name",
	"path": "",
	"incrementId": 0,
	"logLevel": 3,
	"defaultGroupId": 500,
	"defaultModelId": null,
	"defaultMarkId": 380,
	"protocolId": 25
},…]




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

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

Формат: text/plain

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

GET /daemon/receivers/{id}

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


GET /daemon/receivers/21?token=mbs90lon2a8

id: id источника сбора данных

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

Ответ:

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

Формат: json


{
	"id": 21,
	"host": "39.22.197.64",
	"port": 6674,
	"login": "login",
	"password": "password",
	"reconnectTime": 5,
	"useEnginePort": false,
	"defaultEnginePort": null,
	"timezone": 0,
	"useDinGauges": false,
	"useDinAdditionalGauges": false,
	"useAnalogGauges": false,
	"useSpeedGauge": false,
	"name": "Name",
	"path": "",
	"incrementId": 0,
	"logLevel": 3,
	"defaultGroupId": 500,
	"defaultModelId": null,
	"defaultMarkId": 380,
	"protocolId": 15
}




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

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

Формат: text/plain

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

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

Формат: text/plain

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

POST /daemon/receivers

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


POST /daemon/receivers?token=mbs90lon2a8

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

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

Формат: json


{
	"defaultEnginePort": 9874,
	"defaultGroupId": 123,
	"defaultMarkId": 7,
	"defaultModelId": 67,
	"host": "12.154.36.9",
	"incrementId": 15,
	"logLevel": 3,
	"login": "login",
	"mappings": [],
	"name": "New receiver",
	"password": "password",
	"path": "path",
	"port": 5874,
	"protocolId": 21,
	"reconnectTime": 5,
	"timezone": 0,
	"useAnalogGauges": false,
	"useDinAdditionalGauges": false,
	"useDinGauges": true,
	"useEnginePort": true,
	"useSpeedGauge": false
}




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

Ответ:

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

Формат: json


{
	"id": 801,
	"protocol": {
		"id": 21,
		"name": "autotracker",
		"title": "РНТ (АвтоТрекер)",
		"listener": false,
		"receiver": true,
		"writer": false,
		"stable": true
	},
	"host": "12.154.36.9",
	"port": 5874,
	"login": "login",
	"password": "password",
	"reconnectTime": 5,
	"defaultGroup": {
		"id": 2123,
		"name": "lonely car group",
		"notes": "",
		"organizationId": 9383
	},
	"defaultModel": {
		"id": 67,
		"name": "RAPIDE",
		"mark": {
			"id": 7,
			"name": "ASTON MARTIN"
		},
		"expenseOn100km": 11.0,
		"maxTank": 100,
		"motohoursStop": 1.0,
		"motohoursMove": 1.0,
		"markId": 7
	},
	"defaultMark": {
		"id": 7,
		"name": "ASTON MARTIN"
	},
	"useEnginePort": true,
	"defaultEnginePort": 9874,
	"timezone": 0,
	"useDinGauges": true,
	"useDinAdditionalGauges": false,
	"useAnalogGauges": false,
	"useSpeedGauge": false,
	"name": "New receiver",
	"path": "path",
	"incrementId": 15,
	"logLevel": 3,
	"protocolId": 21,
	"defaultGroupId": 2123,
	"defaultModelId": 67,
	"defaultMarkId": 7
}




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

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

// информация о модели ТС по умолчанию
// id модели ТС по умолчанию, целое число
// название модели ТС по умолчанию, строка
// марка модели ТС по умолчанию
// id марки модели ТС, целое число
// название марки модели ТС, строка

// расход топлива на 100 км, число с плавающей точкой
// вместимость топливного бака, целое число
// коэффициент моточасов на стоянке для модели ТС, число с плавающей точкой
// коэффициент моточасов при движении для модели ТС, число с плавающей точкой
// id марки модели ТС, целое число

// информация о марке ТС
// id марки ТС, целое число
// название марки ТС, строка

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

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

Формат: text/plain

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

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

Формат: text/plain

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

PUT /daemon/receivers/{id}

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


PUT /daemon/receivers/20?token=mbs90lon2a8

id: id источника сбора данных

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

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

Формат: json


{
	"defaultEnginePort": 9874,
	"defaultGroup": {
		"id": 2123,
		"name": "Car group",
		"notes": "",
		"organizationId": 9383
	},
	"defaultGroupId": 2123,
	"defaultMark": {
		"id": 7,
		"name": "ASTON MARTIN"
	},
	"defaultMarkId": 7,
	"defaultModel": {
		"expenseOn100km": 11,
		"id": 67,
		"mark": {
			"id": 7,
			"name": "ASTON MARTIN"
		},
		"markId": 7,
		"maxTank": 100,
		"motohoursMove": 1,
		"motohoursStop": 1,
		"name": "RAPIDE"
	},
	"defaultModelId": 66,
	"host": "12.154.36.9",
	"id": 801,
	"incrementId": 15,
	"logLevel": 5,
	"login": "login",
	"mappings": [],
	"name": "New receiver",
	"password": "password",
	"path": "path",
	"port": 5874,
	"protocol": {
		"id": 21,
		"listener": false,
		"name": "autotracker",
		"receiver": true,
		"stable": true,
		"title": "РНТ (АвтоТрекер)",
		"writer": false
	},
	"protocolId": 25,
	"reconnectTime": 5,
	"timezone": 0,
	"useAnalogGauges": false,
	"useDinAdditionalGauges": true,
	"useDinGauges": true,
	"useEnginePort": false,
	"useSpeedGauge": false
}




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

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

// id марки ТС, целое число 
// информация о модели ТС по умолчанию
// расход топлива на 100 км, целое число
// id модели ТС по умолчанию, целое число
// информация о марке ТС
// id марки, целое число
// название марки, строка

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

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

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

Ответ:

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

Формат: json


{
	"id": 20,
	"host": "newserver.com",
	"port": 6644,
	"login": "login",
	"password": "password",
	"reconnectTime": 5,
	"useEnginePort": false,
	"defaultEnginePort": null,
	"timezone": 0,
	"useDinGauges": true,
	"useDinAdditionalGauges": false,
	"useAnalogGauges": false,
	"useSpeedGauge": true,
	"name": "Новое название источника",
	"path": "path",
	"incrementId": 10,
	"logLevel": 5,
	"defaultGroupId": 1945,
	"defaultModelId": 2807,
	"defaultMarkId": 2,
	"protocolId": 21
}




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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

Формат: text/plain

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

DELETE /daemon/receivers/{id}

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


DELETE /daemon/receivers/6?token=mbs90lon2a8

id: id источника сбора данных

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

Ответ:

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

Формат: json


{
    "delete":true
}

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

Формат: text/plain

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

GET /daemon/receivers/count

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


GET /daemon/receivers/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json


47



// количество источников сбора данных

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

Формат: text/plain

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

Posted in