v2.1 Редактирование заметки ТС

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

Запрос:

URL:

PATCH https://api.url/v2.1/user/<user_id>/cars/notes/<note_id>

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

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

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

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

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

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

Поле	Тип	Nullable	Описание
Text	string	нет	да	Текст заметки
IsEditable	bool	да	нет	Может ли текущий пользователь редактировать заметку Не может изменяться при редактировании В запросе может быть null или полностью отсутствовать.
IsDeletable	bool	да	нет	Может ли текущий пользователь удалить заметку Не может изменяться при редактировании В запросе может быть null или полностью отсутствовать.
DateOfCreation	datetime	нет	да	Дата создания заметки Не может изменяться при редактировании В запросе может быть null или полностью отсутствовать.
Important	bool	нет	да	Важная заметка.
AuthorLogin	string	да	да	Login пользователя который оставил заметку Не может изменяться при редактировании В запросе может быть null или полностью отсутствовать.
AuthorFio	string	да	нет	Фио пользователя который оставил заметку Не может изменяться при редактировании В запросе может быть null или полностью отсутствовать.

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

Поле	Тип	Nullable	Описание
Object	Object<car>	нет	С какой ТС связана заметка.

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

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

403 Forbidden - нет прав данное действие.

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

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

Пример

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

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

{
   "data": {
       "type": "note",
       "id": "123",
       "attributes": {
           "Important": true,
       }
   }
}


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

{
   "data": {
       "id": "123",
       "type": "note",
       "attributes": {
           "Text": "Блок снят в ремонт",
           "IsDeletable": true,
           "IsEditable": true,
           "DateOfCreation": "2015-10-14T08:59:09Z",
           "Important": true,
           "AuthorLogin": "Login",
           "AuthorFio": "Фамилиев Имя Отчествович"
       },
       "relationships": {
           "Object": {
               "data": {
                   "id": "1",
                   "type": "car"
               }
           }
       }
   }
}

Page tree