VirtualRef/API/Create - создание вопроса


НАЧАЛО >> Виртуальная справка >> API виртуальной справки >> VirtualRef/API/Create - создание вопроса📄 Скачать в DOCX


Функция VirtualRef/API/Create создает новое обращение виртуальной справки от имени пользователя внешней системы.

Вызов:

UseModule('VirtualRef')->API_Create(
    string $question,
    string $userId,
    int $datetime = 0,
    array $additionalFields = []
): string

1. Параметры

Параметр Тип Обязательный Описание
question string да Текст вопроса. После создания записи сохраняется в SID-файл question.
userId string да Идентификатор пользователя во внешней системе. Если такой пользователь найден в модуле Users, в запись дополнительно переносятся его имя и e-mail.
datetime int нет Время создания вопроса в формате Unix time. Если параметр равен 0, используется текущее время сервера.
additionalFields array нет Дополнительные поля записи. Массив имеет вид $additionalFields[field][occ-1][subfield]=value.

2. Результат

Функция возвращает строковый SID созданной записи запроса справки. Этот идентификатор можно использовать в последующих API-вызовах и при обращении к SID-файлам вопроса.

Если запись не удалось сохранить, выполнение завершается ошибкой с текстом ошибки сохранения записи.

3. Что сохраняется

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

Поле additionalFields удобно использовать для внешнего идентификатора вопроса, разрешения публикации результатов, описания, типа документа, временного диапазона, языка и других интеграционных признаков.