API Car-Online - Экспорт протокола событий

ПОИСК

Экспорт данных

Подключение трекеров

Протокол событий

Позволяет в хронологическом порядке получить список событий от устройства по заданным критериям. Благодаря данной функции Вы можете самостоятельно отслеживать то, что происходило с вашим авто, собирать требуемую статистику. К критериям выборки относятся группы событий и временной интервал.
Запрос и получение данных с сервера происходит по протоколу http.

Формат запроса

URL: http://api.car-online.ru/do?data=events&skey=<ключ>&<другие параметры>

Параметры запроса

Параметр	Описание	Значения	Обязательность
data	Тип требуемой операции	events	Да
skey	Уникальный секретный ключ пользователя и его устройства	кодовая строка	Да
pattern	Шаблон представления данных с сервера	Идентификатор шаблона (по умолчанию, 2)	Нет
content	Тип контента результата	{text, xml} (по умолчанию, text). Если тип xml, то корневой элемент - root.	Нет
begin	Дата/время начала выборки событий	Дата и время в формате ddMMyyyy_HHmmss. Например, 23072009_114059 - 23 июля 2009 года 11 часов 40 минут 59 секунд. (по умолчанию, текущий день с нуля часов)	Нет
end	Дата/время окончания выборки событий	Дата и время в формате ddMMyyyy_HHmmss. Например, 23072009_114059 - 23 июля 2009 года 11 часов 40 минут 59 секунд. (по умолчанию, до конца текущего дня)	Нет
filter	Флаг фильтрации	1 - требуется фильтрация; 0 - без фильтрации. (по умолчанию, 0)	Нет
group	Группа фильтрации событий по их типу (допускается несколько данных параметров)	Значения	Нет (используется, только в случае включения флага фильтрации)
error_p	Шаблон представления ошибки от сервера	Идентификатор шаблона (по умолчанию, 1)	Нет

Формат ответа

Ответ с сервера формируется на основе заданного шаблона представления. Все данные закодированы таблицей UTF-8. В случае необходимости можно задавать атрибут contentType, указывающий на тип получаемой информации для служебных целей (например, чтобы корректно отображал браузер). Распространенные типы контента: text/html (информация представлена в html-формате) и text/xml (xml-разметка).

Описание шаблона представления данных

Для получения данных с сервера нужно определить в каком формате их сформировать. Для этого необходимо задать шаблон. Вы можете использовать один из стандартных шаблонов Car-Online, либо создать свой.

Шаблон протокола событий

Для протокола событий шаблон - это строка символов, описывающая одно событие. В данную строку необходимо вставлять требуемые атрибуты событий. Шаблон может иметь любой формат (xml, просто текст..). Вы можете настраивать только нужные вам атрибуты. Для каждого события из протокла применяется указанный шаблон, которые разделяются новой строкой (то есть шаблоны отделяюся по переносу строки). В шаблоне допускается повторное использование одного и того же атрибута.

Возможные атрибуты шаблона

Атрибут	Описание	Значение
@id	Уникальный идентификатор события	Целое число
@type	Код типа события	Целое число
@datetime	Дата/время события	Дата и время события в формате ddMMyyyy_HHmmss. Например, 23072009_114059 - 23 июля 2009 года 11 часов 40 минут 59 секунд.
@date	Дата события	Дата события в формате ddMMyyyy. Например, 23072009 - 23 июля 2009 года.
@time	Время события	Время события в формате HHmmss. Например, 114059 - 11 часов 40 минут 59 секунд.
@number	Числовой счетчик события в устройстве	Целое число
@gps	Флаг наличия GPS-координат	1 - есть, 0 - нет
@gsm	Флаг наличия GSM-данных	1 - есть, 0 - нет
@balance	Флаг наличия баланса на счете устройства	1 - есть, 0 - нет
@camers	Число фотоснимков	Целое число [0..8]
@brk	Флаг наличия данных бортового компьютера	1 - есть, 0 - нет
@sms	Флаг наличия входящих SMS-сообщений	1 - есть, 0 - нет
@temperature	Флаг наличия сведений о температуре	1 - есть, 0 - нет

Шаблон ошибок от сервера

В случае возникновения ошибок сервер отсылает информацию о возникшей проблеме. Чтобы получать в нужном виде эти сведения можно настроить соответствующий шаблон.

Возможные атрибуты шаблона

Атрибут	Описание	Значение
@code	Уникальный код ошибки	Целое число
@message	Сообщение об ошибке	Строка

Примеры

Ниже представлены наиболее распространенные случаи использования экспорта событий. В качестве тестируемого устройства используется PGSM.

Простой запрос на получение событий текущего дня в стандартном виде

http://api.car-online.ru/do?data=events&skey=914Ff68c6Cb5b65F535b254bb63E15

Ответ

....

Тот же запрос, но ответ в xml-представлении

http://api.car-online.ru/do?data=events&skey=914Ff68c6Cb5b65F535b254bb63E15&content=xml

Ответ

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <event id="89987156" time="30072009_182449" type="41" gps="1" gsm="1" balance="1" brk="1" sms="0" temperature="0" cameras="0"/>
  <event id="89882928" time="30072009_175449" type="41" gps="1" gsm="1" balance="1" brk="1" sms="0" temperature="0" cameras="0"/>
  <event id="89784777" time="30072009_172450" type="41" gps="1" gsm="1" balance="1" brk="1" sms="0" temperature="0" cameras="0"/>

....

Запрос на получение событий за выбранный временной интервал

http://api.car-online.ru/do?data=events&skey=914Ff68c6Cb5b65F535b254bb63E15
&begin=31072009_083000&end=31072009_100800

Ответ

Использование фильтрации событий по группам событий

http://api.car-online.ru/do?data=events&skey=914Ff68c6Cb5b65F535b254bb63E15
&filter=1&group=4

Ответ

....

Применение шаблона представления списка событий

http://api.car-online.ru/do?data=events&skey=914Ff68c6Cb5b65F535b254bb63E15
&pattern=8

Ответ

e:101851479/41/175439
e:101762903/41/172439
e:101663620/41/165439
e:101569504/41/162439
e:101492789/33/155818
e:101489042/41/155439
e:101384652/41/152439
e:101384126/33/151503
e:101384154/60/150056

....