Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на изменение данных фото ТС. Само фото поменять нельзя, только удалить и создать новое.

Запрос:

URL:

      PATCH https://api.url/v2.1/user/<user_id>/cars/<car_id>/photos/<photo_id>

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

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

Content-Type - "application/vnd.api+json".

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


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

 Список атрибутов ТС:

ПолеТипNullableОписание
FileNamestringнетназвание файла
Descriptionstringдаописание файла

Список связанных оъектов

ПолеТипNullableОписание
Carcarнет

ТС к которой привязано фото.

Нельзя менять.

CarMaintenancemaintenanceдаТех. обслуживание к которому привязано фото.
CarAccidentсarAccidentдаДТП к которму привязано фото.

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

200 OK - Сервер обработал запрос. В теле ответа  содержится измененный объект фото ТС.

403 Forbidden - нет прав на изменение фото ТС.

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

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

Пример

Запрос списка всех ТС:

PATCH https://api.url/v2.1/user/1/cars/1/photos/1 HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer auth_token

{
    "data": {
        "id": "1",
        "type": "carPhoto",
        "attributes": {
            "Description": "ДТП вмятина на двери"
        },
        "relationships":{
            "CarAccident": {
                "data": { "id": "1", "type": "carAccident" }
            }
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "carPhoto",
        "id": "1",
        "attributes": {
            "FileName": "the file.jpg",
            "Description": "ДТП вмятина на двери"
        },
        "relationships":{
            "Сar": {
                "data": {"type": "car", "id":"1"}
            },
            "CarMaintenance":{
                "data": null
            },
            "CarAccident": {
                "data": { "id": "1", "type": "carAccident" }
            }
        }
    }
}
  • No labels