Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на создание фото ТС.

Запрос:

URL:

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

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

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

Content-Type - должен быть "multipart/form-data"

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

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

       Запрос отсылается в формате  multipart/form-data. Данные должны содержаться в 2х полях photo и data

Имя параметраОписание
dataДанные по фотографии (связанные объекты/название/формат) в формате JSON API
photoСама фотография

Формат параметра data:

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

Содержит объект с описанием водителя в формате JSON API.

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

ПолеТипОписание
typestringтип ресурса (всегда "carPhoto")
attributesobjectАтрибуты фото

relationships

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

Создание водителя вместе с контактами сейчас не поддерживается. Поле relationships в запросе должно сопутствовать.

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

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

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

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

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

201 Created - Сервер обработал запрос. В теле ответа  содержится фото ТС.

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

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

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

Пример

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

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

{
    "data": {
        "type": "carPhoto",
        "attributes": {
            "FileName": "the file.jpg",
            "Description": null
        },
        "relationships":{
            "Сar": {
                "data": {"type": "car", "id":"1"}
            },
            "CarMaintenance":{
                "data": null
            },
            "CarAccident": {
                "data": null
            }
        }
    }
}


HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Location: https://api.url/v2.1/user/1/cars/1


{
    "data": {
        "type": "carPhoto",
        "id": "1",
        "attributes": {
            "FileName": "the file.jpg",
            "Description": null
        },
        "relationships":{
            "Сar": {
                "data": {"type": "car", "id":"1"}
            },
            "CarMaintenance":{
                "data": null
            },
            "CarAccident": {
                "data": null
            }
        }
    }
}
  • No labels