Public : [r_my_epub_notes] Получение пользователем своих заметок/закладок на книгу в формате epub

Метод используется для получения списка закладок/заметок для книги.

См. также:

[w_replace_my_epub_notes] Перезапись выделений/цитат в формате epub;

[w_set_epub_bookmark_lock] Запросить блокировку выделения/цитаты в формате epub.

ID функции

r_my_epub_notes

Кто может вызывать

Авторизованный пользователь.
Авторизованное приложение.

Принимаемые параметры

art* – ID книги, закладки от которой нас интересуют
group – ID группы, закладки из которой нас интересуют. Если не передан – сервер вернёт все закладки. Имеются следующие «базовые» группы (классы выделения):

0 – текущая позиция в тексте (в этом классе закладка всегда одна);
1 – закладка;
3 – стандартная заметка;

Возвращаемые значения

my_notes* – массив, содержащий список заметок/закладок данной книги:

  • id* – ID заметки;
  • revision* – номер ревизии книги, для которой была сохранена заметка
  • group* – группа (см. параметр group в запросе выше);
  • last_update* – время последней модификации записи;
  • percent* – позиция (процент) начала заметки/выделения в книге (например 5.565);
  • part* – id раздела книги epub, внутри которого находится выделение (соответствует атрибуту id в узле item файла content.opf)
  • xpath_start* – адрес начала выделения, например 'DIV[1]/P[44]/text()[1]' - 44ый узел p внутри второго узла div;
  • offset_start– количество символов внутри узла, после которого начинается выделение;
  • xpath_end – адрес конца выделения (если отсутствует, выделение соответствует «точке»);
  • offset_end – количество символов внутри узла, на котором заканчивается выделение (если отсутствует, выделение соответствует «точке»);
  • class – Расширение атрибута group. Если приложению не хватает 9-и предопределенных групп, можно «надстраивать» расширенную классификацию;
  • title – заголовок заметки, заданный пользователем (plain-text);
  • note – заметка пользователя, строка html, набор <p>, внутри допускаются теги strong/em/sub/sup/code/strike;
  • selection_text – текст выделения, по формату идентичен note, такое же подмножество html, как note.

Если закладки/заметки для книги отсутствуют, то массив my_notes будет пустым.

Возможные ошибки

error_code

error_message

Описание

101061

Несуществующая книга

Книга, к которой произошла попытка сохранить заметки, не существует в каталоге ЛитРес

Пример запроса на сервер

{
   "app": "1",
   "time": "2014-11-07T16:21:02+03:00",
   "sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c",
   "sid": "7bad5f2fb752ee957a4ab74aaac7711g",
   "requests": [
           {
                 "func": "r_my_epub_notes",
                 "id": "my_notes",
                 "param": {
                   "checkpoint": "2014-11-07T16:11:15+03:00",
                   "art": "568640"
           }
   ]
}

Пример ответа сервера

{
   "success": true,
   "time": "2014-11-07T16:21:02+03:00",
   "my_notes" : {
      "success" : true,
      "my_notes": [
      {
        "id": "65830123-26b8-4b07-8098-c18229e5026e",
        "group": "0",
        "last_update": "2014-11-07T16:21:02+03:00",
		"part": "0",
        "xpath_start": "DIV[1]/P[28]/text()[1]",
		"offset_start": "0"
      },
      {
        "id": "65830123-26b8-4b07-8098-c18229e5026f",
        "group": "1",
        "last_update": "2014-11-07T16:21:15+03:00",
		"part": "content2",
        "xpath_start": "DIV[1]/P[44]/text()[1]",
		"offset_start": "7",
        "xpath_end": "DIV[1]/P[44]/text()[1]",
		"offset_end": "362",
        "title": "Вот моё выделение",
        "note": "<p>обожал ее раньше, когда она притворялась сплошным галдящим базаром – ему казалось, что на этом базаре он сможет купить себе любое будущее. Он приезжал тогда в Москву из своей Лобни электричкой – в университет, в клубы, на концерты – и каждый раз воображал себе себя москвичом. Надо было только доучиться, найти работу в центре и снять с друзьями квартиру.</p>"
      }
    ]
  }
}