Закладки

Управление созданием закладок для пользователя. Закладки разделены на три таблицы и должны рассматриваться как кортеж (model, model-id) вместо строки в таблице с id. В методе DELETE используются параметры model и id, потому что DELETE не обязательно поддерживает тело запроса. По этой же логике такой же формат используется и при формировании POST запроса. Поскольку существуют три основные таблицы, id на самой закладке не является уникальным среди “закладок”, поэтому не является уникальным идентификатором для использования в API.

DELETE /api/bookmark/:model/:id

Удалить закладку. Удалит закладку, назначенную для пользователя, который делает запрос, по model и id.

Параметры:

  • model перечисление card, dashboard, collection.

  • id значение должно быть целым числом больше нуля

GET /api/bookmark/

Получает все закладки пользователя.

POST /api/bookmark/:model/:id

Создает новую закладку для пользователя.

Параметры:

  • model перечисление card, dashboard, collection.

  • id значение должно быть целым числом больше нуля

PUT /api/bookmark/ordering

Устанавливает порядок закладок пользователя.

Параметры:

  • orderings значение должно быть массивом. Каждое значение должно быть картой со схемой: ( item_id : целое значение больше нуля type : значение должно быть одним из: card, collection, dashboard. )


<< Назад к разделу API