Получение информации по оценкам

Для использования метода нужна дополнительная настройка на стороне TQM. Для согласования и выполнения настройки обратитесь к своему персональному менеджеру.

Авторизация

При вызове методов интеграционного API через хедер Authorization передается ключ доступа к TQM, полученный в личном кабинете.

Пример значения, которое нужно передать — UuMlW1BUJzVsUM7Q.

Описание метода

Метод позволяет получить подробную информацию по списку ID оценок — в частности, оценочные формы с ответами.

• URL запроса — https://tqm-cloud.tbank.ru/bff-external-clients

• Метод запроса — POST /evaluation/evaluations-view

Запрос

Параметр	Тип	Обязательность	Описание
body	object	true	Тело запроса.
evaluationIds	number	true	Массив идентификаторов оценок. Максимальное значение — 5000.

Ответ

Код ответа	Значение	Описание
201	Created	Запрос выполнен успешно.
400	Bad Request	Ошибка валидации.
401	Unauthorized	Ошибка авторизации.
403	Forbidden	Ошибка доступа к материалу.
500	Internal Server Error	Внутренняя ошибка сервера.

Параметры ответа 201

» указывает на уровень вложенности параметра.

Параметр	Тип	Обязательность	Описание
» data	array	true	Параметры ответа.
»» id	integer	true	ID оценки.
»» status	string	true	Статус: undefined — не определено, draft — черновик, active — активна, deleted — удалена, deactivated — деактивирована.
»» previousStatus	string	true	Предыдущий статус: undefined — не определено, draft — черновик, active — активна, deleted — удалена, deactivated — деактивирована.
»» workgroupId	integer	true	ID отдела.
»» departmentId	integer	true	ID компании.
»» operatorGroupId	integer	true	ID группы.
»» score	number	true	Оценка за звонок (итоговый балл).
»» evaluationFormTemplateName	string	true	Название формы оценки.
»» description	string	true	Описание оценки.
»» isCalibration	boolean	true	true — оценка является калибровкой.
»» evaluationDate	string	true	Дата оценки. Время по UTC.
»» inRating	boolean	true	true — оценка влияет на рейтинг оператора .
»» isDeleted	boolean	true	Всегда false, система не возвращает удаленные оценки.
»» evaluatorFullName	string	true	ФИО оценщика.
»» isVisiblePenalty	boolean	true	true — отображает штраф.
»» formData	object	true	Информация о форме.
»»» noScore	boolean	true	true — форма без оценки.
»»» bonus	object	true	Бонусы.
»»»» index	integer	true	Индекс бонуса.
»»»» name	object	true	Название.
»»»»» additionalProperties	object	false	Дополнительные свойства.
»»»»»» value	string	true	Значение.
»»»» size	object	true	Размер.
»»»»» additionalProperties	object	false	Дополнительные свойства.
»»»»»» value	number	true	Значение.
»»»» noBonus	boolean	true	true — без бонуса.
»»»» id	string	true	ID бонуса.
»»» penalty	object	true	Штраф.
»»»» index	integer	true	Индекс штрафа.
»»»» name	object	true	Название.
»»»»» additionalProperties	object	false	Дополнительные свойства.
»»»»»» value	string	true	Значение.
»»»» size	object	true	Размер.
»»»»» additionalProperties	object	false	Дополнительные свойства.
»»»»»» value	string	true	Значение.
»»»» noPenalty	boolean	true	true — без штрафа.
»»»» id	string	true	ID штрафа .
»»» blocks	array	true	Блок формы.
»»»» blockIndex	integer	true	Индекс блока.
»»»» blockName	string	true	Название блока.
»»»» blockId	string	true	ID блока.
»»»» hideFromOperator	boolean	true	true — блок скрыт от оператора.
»»»» questions	array	true	Вопросы.
»»»»» questionIndex	integer	true	Индекс вопросов.
»»»»» selectAnswer	object	true	Выбор ответа.
»»»»»» additionalProperties	object	false	Дополнительные свойства.
»»»»»»» index	integer	true	Индекс.
»»»»»»» text	string	true	Текст.
»»»»»»» score	number	true	Оценка.
»»»»»»» noScore	boolean	true	true — без оценки.
»»»»»»» penalty	number	true	Штраф.
»»»»»»» commentRequired	boolean	true	true — требуется комментарий.
»»»»»»» bonus	number	true	Бонус.
»»»»»»» defaultAnswer	boolean	true	true — ответ по умолчанию.
»»»»»»» id	string	true	ID ответа.
»»»»» multiSelectAnswer	array	true	Несколько вариантов ответа.
»»»»» questionId	string	true	ID вопроса.
»»»»» questionName	string	true	Название вопроса.
»»»»» canCommentQuestion	boolean	true	true — можно прокомментировать вопрос.
»»»»» questionRequired	boolean	true	true — обязательный вопрос.
»»»»» questionType	object	true	Тип вопроса.
»»»»»» id	string	true	ID вопроса.
»»»»»» value	string	true	Значение.
»»»»» textAnswer	string	true	Текст ответа.
»»»»» checkboxAnswer	boolean	true	true — есть чекбокс ответа.
»»»»» comment	object	true	Информация о комментарии.
»»»»»» bad	string	true	Плохо.
»»»»»» good	string	true	Хорошо.
»»»»»» comment	string	true	Комментарий.