Методы JSON-RPC

НАЧАЛО >> Битрикс24 >> Методы JSON-RPC📄 Скачать в DOCX

Методы перечислены по фактическому классу Bitrix24_JSONRPCServer. Все названия методов чувствительны к регистру, потому что вызываются как публичные PHP-методы серверного объекта.

1. Читатели

Метод Параметры Результат
GetUser user_id Содержимое записи читателя в виде массива полей. Если запись не найдена и включено создание через LDAP, модуль может создать запись из LDAP-данных.
AddUser user_id = "", user_rec_array = {} Создает запись читателя из массива полей, при указанном user_id записывает его в поле 30; при успехе возвращает 0.
UpdateUser user_id = "", user_rec_array = {} Находит читателя по user_id, заменяет содержимое записи переданным массивом полей и возвращает 0.
DelUser user_id = "" Удаляет запись читателя. Возвращает результат удаления БД или код ошибки, если БД/читатель не найдены.
UserFormular user_id Возвращает массив текущих выдач из формуляра читателя.

user_rec_array передается в формате массива полей записи ИРБИС 128. При передаче JSON-объекта сервер преобразует его в массив перед сохранением.

Строки формуляра содержат:

Поле результата Значение
record_id Шифр библиографической записи.
db БД библиографической записи.
bo Краткое библиографическое описание.
need_return_date Плановая дата возврата.
issue_date Дата выдачи.
barcode_rfid Штрихкод или RFID экземпляра.
inventory Инвентарный номер.
place_of_issue Место выдачи.
place_of_store Место хранения.
responsible_face Ответственное лицо.

2. Заказы и продление

Метод Параметры Результат
MakeOrder user_id, dbn, record_id, place_of_issue = "" Создает заказ на запись каталога, найденную в dbn по шифру record_id; при успехе возвращает 0.
DeleteOrder user_id, record_id Находит заказ пользователя по шифру записи, помечает его как удаленный читателем и возвращает 0.
GetOrders user_id Возвращает массив заказов пользователя.
BookReturnProlongation user_id, barcode_rfid, inventory, new_return_date Продлевает срок возврата выданного экземпляра и возвращает дату, рассчитанную модулем Bookland.

new_return_date передается в формате ГГГГММДД. Экземпляр для продления определяется по barcode_rfid или inventory.

Строки GetOrders содержат:

Поле результата Значение
db БД каталога.
record_id Шифр записи заказа.
user_id Идентификатор читателя.
bibliography Библиографическое описание из заказа.
responsible_face Ответственное лицо.
place_of_issue Место выдачи.
place_of_store Место хранения.
barcode_rfid Штрихкод или RFID экземпляра.
inventory Инвентарный номер.
order_date Дата заказа.
issue_date Дата выдачи.
reservation_date Дата передачи в бронь.
refuse_date Дата отказа.
refuse_reason Причина отказа.
is_edd Признак ЭДД.
edd_url Ссылка на ЭДД-документ, если она сформирована.
status Числовой статус заказа.

Статусы заказа:

Код Значение
0 Заказ ожидает обработки.
1 Заказ передан в бронь или к месту выдачи.
2 Заказ получен в месте выдачи.
3 Заказ отклонен.
4 Издание выдано.
10 Заказ успешно создан.

3. Каталог, экземпляры и форматирование

Метод Параметры Результат
GetExemplarsInfo dbn, record_id Возвращает сведения об экземплярах библиографической записи: доступные и занятые экземпляры, места хранения, инвентарные номера и связанные БД.
Search dbn, exp, seq, format, numMfn = 20, firstMfn = 0, Min = 0, Max = 0 Выполняет поиск в БД, форматирует найденные записи и возвращает массив результата.
GetTermList dbn, pref, startTerm, numTerms = 20, isBack = false, format = "" Возвращает список терминов словаря БД.
GetFasets dbn, exp, celltype, cellnum Возвращает фасеты для поискового выражения.
RecVirtualFormat dbn, format, rec_array Создает виртуальную запись из массива полей и форматирует ее указанным форматом.

В Search параметр format передается в форматтер БД. Для интеграционного ответа можно использовать формат @Bitrix24/recdata; он возвращает JSON со следующими полями:

Поле Значение
record Полное содержимое записи как массив полей.
brief Краткое форматированное описание.
@ Полное форматированное описание.
mfn MFN записи.

RecVirtualFormat полезен, когда внешняя система уже собрала массив полей и ей нужно получить результат штатного форматирования ИРБИС 128 без сохранения записи в БД.