НАЧАЛО >> Виртуальная справка >> API виртуальной справки📄 Скачать в DOCX
Модуль предоставляет внешние функции для интеграции виртуальной справки с личным кабинетом или внешней справочной системой.
Функция VirtualRef/API/Create создает вопрос и возвращает SID созданной записи.
Основные параметры:
question - текст вопроса;userId - идентификатор пользователя во внешней системе;datetime - дата и время создания, если нужно передать внешнюю метку времени;additionalFields - дополнительные сведения: внешний идентификатор, разрешение публикации результатов, описание, тип документа, временной диапазон, язык, e-mail, телефон для связи и другие поля. Состав реквизитов поля 71 описан в разделе Дополнительная информация о вопросе.Функция VirtualRef/API/Get возвращает список вопросов, измененных после указанной метки времени, и может фильтровать вопросы по пользователю.
Результат описан структурой (разд. "class VirtialRef_API_Get"). В ответ попадают текст вопроса, статус, пользователь, ответ, телефон для связи, ссылки, библиография, ссылки на записи электронного каталога и вложения.
Если в записи вопроса заполнено поле 71^I, функция возвращает его в свойстве phoneNumber. Поле предназначено для телефона для связи; если телефонов несколько, они передаются одной строкой через запятую.
Функция VirtualRef/API/Hide помечает вопрос как скрытый для внешнего личного кабинета. Внутренняя запись при этом сохраняется.
Подробное назначение реквизитов приведено в разделе Дополнительная информация о вопросе.
71^A - идентификатор вопроса во внешней системе.71^B - разрешение публиковать результаты поиска.71^C - дополнительное описание.71^D и 71^E - тип документа и другой тип документа.71^F - временной диапазон.71^G - язык представления информации.71^H - признак скрытия в личном кабинете.71^I - телефон для связи. Если телефонов несколько, они записываются одной строкой через запятую и возвращаются в VirtualRef/API/Get как phoneNumber.