Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Получение информации о ускорениях в момент ДТП.

Запрос:

URL:

GET https://api.url/v2.1/user/<user_id>/cars/accidents/<accident_id>/accelerations

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

If-Modified-Since - Если ранее уже запрашивался полный список ДТП, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

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

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

Ответ:

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

ПолеОписание
links

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

data

Содержит объект ускорения ДТП в формате JSON API.

Каждый объект содержит

ПолеТипОписание
idintИдентификатор
typestringТип ресурса (всегда "carAccidentAcceleration")
attributesobjectОписание атрибутов см. ниже
relationshipsobject

Связанные объекты

included

Необязательное поле. Появляется если в запросе задан параметр include.

Содержит массив объектов связанных с объектами в ответе.

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

ПолеТипNullableФильтрацияОписание
Accelerationsarray<Acceleration>нетнетМассив ускорений в момент ДТП

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

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

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

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

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

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

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

Пример

GET https://api-test05.citypoint.ru/v2.1/user/1/cars/accidents/1/accelerations 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
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://api-test05.citypoint.ru/v2.1/user/1/cars/accidents/1/accelerations"
    },
    "data": {
        "id": "1",
        "type": "carAccidentAcceleration",
        "attributes": {
            "Accelerations": [
                {
                    "zF": -1.734750748,
                    "zS": -0.765069723,
                    "zV": 2.188456535,
                    "time_offset": "-3.84000015"
                },
                ...
                {
                    "zF": 1.149367690,
                    "zS": 1.042153120,
                    "zV": 1.050065160,
                    "time_offset": "-0.00802119169"
                },
                {
                    "zF": -0.088719480,
                    "zS": -0.156827301,
                    "zV": 1.285057187,
                    "time_offset": "-2.11913139e-05"
                },
                {
                    "zF": 0.109080628,
                    "zS": 0.035638854,
                    "zV": 1.205361366,
                    "time_offset": "0.00797880907"
                },
                ...
                {
                    "zF": 0.215875149,
                    "zS": 0.053977959,
                    "zV": 1.104211569,
                    "time_offset": "2.99196863"
                }
            ]
        },
        "relationships": {
            "CarAccident": {
                "data": {
                    "id": "42",
                    "type": "carAccident"
                }
            }
        }
    }
}
  • No labels