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

См. также:

ID функции

r_my_audio_notes

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

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

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

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

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

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

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

  • id* – ID заметки;
  • group* – группа (см. параметр group выше);
  • last_update* – время последней модификации записи;
  • file* – номер трека-главы соответствующей аудиокниги;
  • filename* – название трека-главы соответствующей аудиокниги;
  • time_start* – начальное время позиции в секундах соответствующего трека-главы. *Пока для закладки используем только этот параметр;
  • time_end* – конечное время позиции в секундах соответствующего трека-главы. *Этот параметр заложен для будущей реализации функционала выделения части трека «аудио цитаты»;
  • percent* – процент прослушанного. Вычисляется на основе данных о номере главы аудио файла и времени, когда пользователь остановил прослушивание. Значение возвращается, если group = 0, в виде относительной величины, например, '53', означает, что аудиокнига прослушана на 53%;
  • title – заголовок закладки, заданный пользователем.

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

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

error_code

error_message

Описание

101087

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

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

101144

Позиция timet некорректна

Позиция, описанная в file, time_start или time_end, некорректна: находится за пределами книги или соответствующие узлы не существуют и т. п.

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

{
   "app": "1",
   "time": "2014-11-07T16:21:02+03:00",
   "sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c",
   "sid": "7bad5f2fb752ee957a4ab74aaac7711g",
   "requests": [
           {
                 "func": "r_my_audio_notes",
                 "id": "my_notes",
                 "param": {
                   "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",
    	"file": "6",
        "filename": "05.mp3",
        "time_start": "45",
  		"time_end": "",
        "percent" : "53"
  		},
  		{
 	   	"id": "65830123-26b8-4b07-8098-c18229e5026f",
    	"group": "1",
    	"last_update": "2014-11-07T16:21:15+03:00",
        "file": "6",
        "filename": "05.mp3",
        "time_start": "49",
	    "time_end": "",
    	"title": "Вот я тут выделил че-то"
  		}
		]
  }
}

Comments:

в реальности на бою не uuid, а id

Posted by fedorova at May 30, 2018 16:12