Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на изменение Параметров ТС.

Запрос:

URL:

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

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

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

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

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


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

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

В attributes передаются изменённые атрибуты ТС (список всех параметров можно получить в методе v2.1 Список параметров объектов).

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

ПолеТипNullableОписание
CarObject<car>нетСсылка на ТС, изменять нельзя.

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

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

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

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

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

Пример

Изменение параметра "Вес ТС", удаление параметра "Максимальная разрешённая скорость ТСВес ТС" и изменение цвета на белый.

PATCH https://api.url/v2.1/user/1/cars/params/1 HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>

{
    "data": {
        "id": 1,
        "type": "carParams",
        "attributes": {
            "CAR_WEIGHT": 8420,
            "CAR_MAXIMUM_SPEED": null,
            "CAR_COLOR": "FFFFFF",
        }
    }
}


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

{
    "links": {
        "self": "https://api.url/v2.1/user/1/cars/params/1",
    },
    "data": {
        "type": "carParams",
        "id": "1",
        "attributes": {
                "CAR_OFFLINE_THRESHOLD": 120,
                "CAR_MAXIMUM_SPEED": null,
                "CAR_FMS_ODOMETER_THRESHOLD": null,
                "CAR_MAINTENANCE_DATE": null,
                "CAR_MAINTENANCE_MILEAGE": null,
                "CAR_PRIMARY_INSURANCE_DATE": null,
                "CAR_SECONDARY_INSURANCE_DATE": null,
                "CAR_TAHO_CALIBRATION_TO_DATE": null,
                "CAR_SERTICATE_SERIAL_NUMBER": null,
                "CAR_WEIGHT": 8420,
                "CAR_COLOR": "00FEFE",
                "CAR_MAX_ALLOWED_WEIGHT": null,
                "CAR_ECO_CLASS": null,
                "CAR_CHASSIS": null,
                "CAR_BODY": null,
                "CAR_ODOMETER_LIMIT_DAILY": null,
                "CAR_ODOMETER_LIMIT_WEEKLY": null,
                "CAR_ODOMETER_LIMIT_MONTHLY": null,
                "CAR_ODOMETER_LIMIT_YEARLY": null,
                "CAR_ODOMETER_LIMIT_ON_HOLIDAY": null,
                "WINTER_START_DATE": null,
                "WINTER_END_DATE": null,
                "CAR_ODOMETER_LIMIT_MONTHLY_ON_HOLIDAY": null,
                "CAR_TRANSMISSION": "2",
                "CAR_NUMBER_OF_PASSENGERS": null,
                "CAR_NUMBER_OF_DOORS": null,
                "CAR_ENGINE_POWER": null,
                "CAR_START_UP_DATE": null,
                "CAR_ENGINE_VOLUME": null,
                "CAR_OWNER": null,
                "CAR_COLOR_HEX": null,
                "CAR_LEASING_COMPANY": null,
                "CAR_MAXIMUM_SPEED_WINTER": null,
                "CAR_ODOMETER_LIMIT_YEARLY_ON_HOLIDAY": null
	    },
        "relationships": {
               "Car": { "data": {"type": "car": "id": "1"} }
        }
   }
}
  • No labels