Запрос позволяет получить подробную информацию по всем или выбранным читателям ваших библиотек.

ID функции

r_biblio_reader_list

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

Авторизованное приложение, имеющее разрешение на работу с библиотечным API <ссылка TODO>

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

libhouses – массив ID библиотек, из которых выбираются списки читателей. В массиве обязательно должен быть хотя бы один ID библиотеки. Этот ID выдаётся менеджером ЛитРес при получении доступа к API или получается через запрос <TODO>, если вы являетесь оператором группы библиотек;

lib_cards – массив с номерами читательских билетов. Если в запросе есть этот параметр, то игнорируется переданный в libhouses список библиотек, а в выдаче содержится информация только по запрошенным читателям. При отсутствии этого параметра в выдаче будут все читатели библиотек.

Один из параметров (libhouses или lib_cards) должен быть указан обязательно.

limit  – ограничение на количество возвращаемых читателей. Работает аналогично инструкции limit в MySQL и в запросе представлен массивом из двух чисел N,M. Если limit указан­ – возвращается M персон, начиная с персоны N (у первой номер 0). Если limit не задан – значение по умолчанию «0,10»;

fields* – перечень полей, которые нужны клиенту:

libhouse – ID библиотеки, к которой привязан читатель. 
login – логин читателя. Логин может отличаться от номера читательского билета (не актуально для школьных библиотек);
name – имя читателя в читательском билете;
birth_date – дата рождения в ISO-формате «1999-12-21»;
phone – номер мобильного телефона читателя с кодом страны. Пример: «79161234567» или «380341234567»;
mail – e-mail читателя;
groups – библиотечные группы, в которых числится читатель: филиалы, классы и пр.;
is_blocked – заблокирован ли читательский билет или нет;
is_hybrid – есть ли у читателя возможность совершать розничные покупки на ЛитРес за собственные деньги (не актуально для проекта «ЛитРес: Школа»);
create_date – дата и время создания читательского билета в ISO-формате «2017-04-25 12:43:48».

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

Красной звездочкой отмечены параметры, которые гарантировано будут в выдаче:

pager* → rows* – общее количество найденных читательских билетов;

readers* – массив, содержащий информацию по читателям. Если не было найдено ни одного читателя, то массив readers будет пустым. Параметры:

libhouse* – ID библиотеки, к которой привязан читатель;
id* – номер читательского билета (выводится всегда, вне зависимости от значения fields);
login* – логин читателя. Логин может отличаться от номера читательского билета (не актуально для школьных библиотек);
name* – имя и фамилия читателя;
birth_date* – дата рождения в ISO-формате «1999-12-21»;
phone – номер мобильного телефона читателя с кодом страны. Пример: «79161234567» или «380341234567»;
mail – e-mail читателя;
groups – массив с названиями библиотечных групп, в которых числится читатель. Например, группами могут быть филиалы, классы и пр. Если читатель не числится ни в одной группе – массив будет пустым. 
is_blocked* – заблокирован ли читательский билет или нет;
is_hybrid* – есть ли у читателя возможность совершать розничные покупки на ЛитРес за собственные деньги (не актуально для школьных библиотек);
create_date* – дата и время создания читательского билета в ISO-формате «2017-04-25 12:43:48».

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

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

{
   "app": "1",
   "time": "2014-11-07T16:21:02+03:00",
   "sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c",
   "sid": "7bad5f2fb752ee957a4ab74aaac7711g",
   "requests": [
           {
                 "func": "r_biblio_reader_list",
                 "id": "my_readers_list",
                 "param": {
                   "libhouses": [
							"51234564",
							"41234569"
					],
                   "lib_cards": [
							"151234564",
							"251234564"
					],
					"fields": [
						"libhouse", "login", "name", "birth_date", "phone", "mail", "groups", "is_blocked", "is_hybrid"
					],
					"limit": ["0","100"]
                 }
           }
   ]
}

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

{
   "success" : true,
   "time" : "2018-07-18T13:37:57+03:00",
   "biblio_reader_list" : {
      "success" : true,
      "pager" : {
         "rows" : "72"
      },
      "readers" : [
       {
          "create_date" : "2018-07-13 17:11:36",
          "is_blocked" : "0",
          "is_hybrid" : "0",
          "login" : "login",
          "id" : "402694454",
          "mail" : "login@mail.ru",
          "birth_date" : "2000-07-13",
          "libhouse" : "20927456",
          "name" : "Вася"
       },
       {
          "libhouse" : "20927456",
          "birth_date" : "1993-11-21",
          "name" : "Бу",
          "mail" : "bu@bu.com",
          "is_hybrid" : "0",
          "login" : "bububu",
          "id" : "403573278",
          "create_date" : "2018-07-17 20:14:46",
          "is_blocked" : "0"
       }
      ]
   }
}