Page tree

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

Skip to end of metadata
Go to start of metadata

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

Запрос:

URL:

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

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

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

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

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


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

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

ПолеТипNullableОписание
TextstringнетдаТекст заметки
IsEditableboolнетнет

Может ли текущий пользователь редактировать заметку

Не используется при создании - всегда пишется текущий авторизованный пользователь.

При создании может быть null или полностью отсутствовать.

IsDeletableboolнетнет

Может ли текущий пользователь удалить заметку

Не используется при создании - всегда пишется текущий авторизованный пользователь.

При создании может быть null или полностью отсутствовать.

DateOfCreationdatetimeнетдаДата создания заметки
Importantboolнетда

Важная заметка.

AuthorLoginstringдада

Login пользователя который оставил заметку.

Не используется при создании - всегда пишется текущий авторизованный пользователь.

При создании может быть null или полностью отсутствовать.

AuthorFiostringданет

Фио пользователя который оставил заметку.

Не используется при создании - всегда пишется текущий авторизованный пользователь.

При создании может быть null или полностью отсутствовать.

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

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

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

201 Created - Сервер обработал запрос. В теле ответа  содержатся данные созданного объекта.

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

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

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

Пример

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

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

{
   "data": {
       "type": "note",
       "attributes": {
           "Text": "Блок снят в ремонт",
           "Important": true,
       },
       "relationships": {
           "Object": {
               "data": {
                   "id": "1",
                   "type": "car"
               }
           }
       }
   }
}


HTTP/1.1 201 Created
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"
               }
           }
       }
   }
}
  • No labels