Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на редактирование связки объектов. На текущий момент доступна только отвязка объектов (через установку UnlinkDate).

Запрос:

URL:

      PATCH https://api.url/v2.1/user/<user_id>/cars/carLinkages/<link_id>

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

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

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

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


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

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

ПолеТипNullableОписание
LinkDateDatetimeнетДата с которой действует привязка.
UnlinkDateDatetimeдаДата до которой действует привязка.

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

ПолеТипNullableОписание
MainCarobject<car>нет

Основная ТС - та к которой добавляется связь.

LinkedCarobject<car>нетСвязанная ТС - та с которой идут доп. данные.

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

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

403 Forbidden - нет прав на изменение объектов.

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

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

Пример

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

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

{
    "data": {
        "type": "carLinkage",
        "attributes": {
            "LinkDate": "2020-10-13T10:11:40Z",
            "UnlinkDate": "2020-10-17T10:11:40Z"
        },
        "relationships": {
            "MainCar": {
                "data": {
                    "id": "1",
                    "type": "car"
                }
            },
            "LinkedCar": {
                "data": {
                    "id": "2",
                    "type": "car"
                }
            }
        }
    }
}


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

{
    "links": {
        "self": "http://api.url/v2.1/user/1/cars/cars/carLinkages/1",
    },
    "data": {
        "id": "1",
        "type": "carLinkage",
        "attributes": {
            "LinkDate": "2020-10-13T10:11:40Z",
            "UnlinkDate": "2020-10-17T10:11:40Z"
        },
        "relationships": {
            "MainCar": {
                "data": {
                    "id": "1",
                    "type": "car"
                }
            },
            "LinkedCar": {
                "data": {
                    "id": "2",
                    "type": "car"
                }
            }
        }
    }
}
  • No labels