v2.1 Сводная информация по всем Водителям

Сводной информация о всех ТС для отчетов.

Запрос:

URL:

GET https://api.url/v2.1/user/<user_id>/drivers/aggregated/<date_to>/<period>

Данные рассчитываются раз в день за все возможные периоды. При запросе текущего (ещё не рассчитанного) дня будет возвращаться ошибка 404.

Доп. Заголовки:

Accept - для указания формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

Параметр	Тип	Значение по умолчанию	Описание
page[offset]	int	0	Пропустить несколько первых записей
page[limit]	int	40000	Количество ТС в выводе
fields[driverAggrData]	string		Фильтрация полей отображаемых в агрегированных данных
filter[driverAggrData]	string		Фильтрация возвращаемых результатов (см. раздел "Фильтрация результатов")
sort	string		Сортировка по указанному полю

Периоды доступные в запросе

Значение	Описание
day	Данные агрегированные за день указанный в date_to
week	Данные агрегированные за неделю
month	Данные агрегированные за месяц
quarter	Данные агрегированные за квартал

Ответ:

Ответ присылается в формате JSON API.

Поле

Описание

links

Поле links содержит ссылки на доступные ресурсы.

Минимально он должен содержать ссылку на текущий ресурс (self).

Если Все записи не удалось поместить в одном ответе то также будет содержаться

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами

Описание атрибутов:

Поле	Тип	Nullable	Описание
Scoring	double	да	Скоринговый бал за указанный период.

В будущем возможно добавление новых дополнительных данных. Парсеры должны игнорировать атрибуты назначение которых им неизвестно.

Коды ответов:

200 ОК - Сервер обработал запрос. В теле ответа содержится список агрегированных данных для каждого водителя.

401 Unauthorized - не передан заголовок Authorization, либо токен невалидный или окончилась валидация.

403 Forbidden - нет прав на просмотр данных

404 Not Found - Данные ещё не рассчитаны, период недоступен.

400 Bad Request - Переданы не поддерживаемые параметры, либо сервер не понял запрос (описание ошибки в теле ответа).

Также возможны другие ошибки.

Пример

GET http://api.url/v2.1/user/1/drivers/aggregated/2014-10-09/day HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
         
{
    "links": {
        "self": "http://api.url/v2.1/user/1/drivers/aggregated/2014-10-09/day",
    },


    "meta": {
        "total_count": 2,
        "summary": {
            "Scoring": 642
        }
    },
    "data": [ 
        {  "type": "driverAggrData",
           "id": "1.20141009.day",
           "attributes":{
               "Scoring": 321
           },
           "relationships":{
			   "Driver": { "data":{ "type": "driver", "id":"1" } } 
           } 
       }
       ... данные по остальным водителям ...
   ]
   
 }

Page tree