Головна API документація Отримати каталог тестів

Отримати каталог тестів

Востаннє оновлено Apr 27, 2026

GET /v1/tests повертає каталог тестів, доступних поточній компанії: системні тести та власні тести компанії. Integrated synthetic-тести SCORM/CMI5/xAPI у відповідь не входять.

Endpoint

Метод URL
GET https://smartway.pro/api/v1/tests

Призначення

Отримати список тестів, які можна використовувати для тестування кандидатів або співробітників.

Передумови

Вимога Значення
Авторизація Authorization: Bearer <access_token>
Scope tests.read
Tenant context Визначається сервером з Bearer token
idCompany Не передається зовнішнім клієнтом

curl приклад

curl -X GET 'https://smartway.pro/api/v1/tests' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Accept: application/json'

Відповідь

Успішна відповідь: 200 OK.

{
  "data": [
    {
      "testId": 5,
      "name": "Conflict Test",
      "active": true,
      "companyOwned": false,
      "questionCount": 30
    },
    {
      "testId": 200001,
      "name": "Adaptive Sales",
      "active": true,
      "companyOwned": true,
      "questionCount": 12
    }
  ],
  "meta": {
    "total": 2
  }
}

Поля відповіді

Поле Тип Опис
data object[] Список тестів, доступних поточній компанії
data[].testId int64 ID тесту
data[].name string Назва тесту
data[].active boolean Ознака активності тесту
data[].companyOwned boolean true, якщо тест належить поточній компанії
data[].questionCount int32 Кількість питань у тесті
meta.total int32 Загальна кількість тестів у відповіді

Бізнес-логіка

  • Компанія визначається з Bearer token.

  • Повертаються системні тести та тести, що належать поточній компанії.

  • Поле companyOwned показує, чи належить тест поточній компанії.

Edge cases

Сценарій Поведінка API
Тест є integrated synthetic-тестом SCORM/CMI5/xAPI Тест не входить у каталог
У токені немає company context API повертає 403 Forbidden

Помилки

HTTP status Причина
401 Unauthorized Відсутній або невалідний Bearer token
403 Forbidden Недостатньо прав або токен без company context
500 Internal Server Error Неочікувана помилка LMS Smart Way
503 Service Unavailable Збій внутрішньої інтеграції LMS Smart Way

Використання

Використовуйте endpoint, щоб отримати доступні testId перед створенням запрошення або налаштуванням фільтрів звітів.

Типові помилки

Помилка Як уникнути
Використання токена без tests.read Перевірте scope API key
Передавання idCompany у запиті Не передавайте idCompany; компанія визначається з токена
Очікування SCORM/CMI5/xAPI synthetic-тестів у каталозі Цей endpoint такі тести не повертає

FAQ

Чи потрібно передавати idCompany?

Ні. Компанія визначається сервером з Bearer token.

Чи входять SCORM/CMI5/xAPI synthetic-тести у відповідь?

Ні. Вони не входять у каталог GET /v1/tests.