v2.1 Редактирование параметров отчета по ДТП

Редактирование параметров отчета о ДТП.

Также служит для запуска перестроения отчета.

Запрос:

URL:

PATCH https://api.url/v2.1/user/<user_id>/cars/accidents/<accident_id>/report

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

Accept - должен допускать "application/vnd.api+json".

Content-Type - должен быть "application/vnd.api+json".

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

Данные запроса:

Данные присылаются в формате JSON API. Формат данных аналогичен формату данных в ответе на запрос получения данных одиночного объекта.

Ответ присылается в формате JSON API. В заголовке Location будет содержаться ссылку на созданные объект. В теле ответа будет полное описание созданной объекта.

Поле

Описание

data

Содержит объект параметры отчета ДТП в формате JSON API.

Поле	Тип	Описание
id	int	Идентификатор
type	string	Тип ресурса (всегда "сarAccident")
attributes	object	Описание атрибутов см. ниже

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

Поле	Тип	Nullable	Описание
TrackStartDate	datetime	да	нет	Дата и время начала отображения трека. auto - трек будет строиться от момента включения зажигания после простоя продолжительность DowntimeSeconds
DowntimeSeconds	int	нет	нет	Продолжительность простоя, являющиеся разделителем поездок при автоматическом построении трека
DetailingSecondsBeforeAccident	int	нет	нет	Период вывода таблицы детализации
DetailingSecondsAfterAccident	int	нет	нет	Период вывода таблицы детализации
AccelerationsStart	text Должно содержать число	да	нет	Вывод детализации ускорений - с какого пакета показывать график ускорений. Данные из пакета accelerations - time offset.
AccelerationsEnd	text Должно содержать число	да	нет	Вывод детализации ускорений - до какого пакета показывать график ускорений. Данные из пакета accelerations - time offset.
MapTrackBBox	array<float, 4>	да	нет	BBox карты с трэком ТС до аварии (карта с длинным трэком) Bbox содержит северо-восточный и юго-западный угол видимой карты в формате: [ Север, Восток, Юг, Запад ]

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

200 ОК - Сервер обработал запрос. В теле ответа содержится обновленные параметры отчета о ДТП. Также будет передан заголовок Last-Modified.

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

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

403 Forbidden - нет прав на выполнение запроса.

404 Not Found - дтп или отчет не найдены.

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

Пример

PATCH https://api.url/v2.1/user/1/cars/accidents/1/report HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
{
    "data": {
        "id": "1",
        "type": "carAccidentReport",
        "attributes": {
            "TrackStartDate": "2021-04-21T13:12:41Z",
            "DowntimeSeconds": 1234,
            "MapTrackBbox": [85,21,31,12]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://api-test05.citypoint.ru/v2.1/user/1/cars/accidents/1/report"
    },
    "data": {
        "id": "1",
        "type": "carAccidentReport",
        "attributes": {
            "TrackStartDate": "2021-04-21T13:12:41Z",
            "DowntimeSeconds": 1234,
            "DetailingSecondsBeforeAccident": 10,
            "DetailingSecondsAfterAccident": 5,
            "AccelerationsStart": null,
            "AccelerationsEnd": null,
            "MapTrackBbox": [85,21,31,12]
        }
    }
}

Page tree