Перейти к основному контенту

Мобильный автономный комплекс

Данная модель описывает REST-API интерфейс сервиса мобильного автономного комплекса

Авторизация

Аутентификация в сервисе МАК и получение токена сессии

Строка запроса POST: /token

Параметры запроса:
Параметр Значение Описание
grant_type Список (enum) Тип авторизации, по умолчанию password
username Текстовый Логин пользователя
password Текстовый Пароль пользователя
scope Текстовый Область видимости
client_id Числовой Идентификатор клиента
client_secret Текстовый Ключ доступа клиента
Варианты ответа:

Ошибка 401

{
  "detail": "UNAUTHORIZED"
}

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно

{
  "access_token": "Токен аутентификации",
  "token_type": "baerer"
}

Пользователь

Получение информации о пользователе

Строка запроса GET: /api/v1/person/info

Параметры запроса:

Не имеет параметров

Варианты ответа:

Успешно

{
  "name": "Имя пользователя"
}

Экзамен

Получает список запланированных экзаменов

Строка запроса GET: /api/v1/exam/events

Параметры запроса:
Параметр Значение Описание
dtfrom Дата и время Дата-время начала периода, по умолчанию - текущее время/
dtto Дата и время Дата-время окончания периода, по умолчанию - текущее время
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно

[
  {
    "id": "Идентификатор экзамена",
    "start": "Дата-время начала экзамена",
    "end": "Дата-время окончания экзамена",
    "title": "Название экзамена",
    "content": "Содержание/Описание экзамена",
    "class": "Вид принимаемого экзамена"
  }
]

Получает сведения о запланированном экзамене по его идентификатору

Строка запроса GET: /api/v1/exam/{exam_id}

Параметры запроса:
Параметр Значение Описание
exam_id Числовой Идентификатор экзамена (часть запроса)
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно

[
  {
    "id": "Идентификатор экзамена",
    "begin_utc": "Дата-время начала экзамена по гринвичу",
    "end_utc": "Дата-время окончания экзамена по гринвичу",
    "s_type": "Тип экзамена",
    "experts": [
      {
        "id": "Идентификатор эксперта",
        "name": "ФИО эксперта"
      }
    ],
    "student": {
      "id": "Идентификатор соискателя",
      "name": "ФИО соискателя"
    },
    "exam": "Экзамен"
    "actions": [
      { 
        "id": "Идентификатор действия эксперта",
        "a_type": "Тип действия",
        "created_utc": "Дата возникновения действия по гринвичу",
        "expart_id": "Идентификатор эксперта",
        "data": "Данные действия эксперта"
      }
    ]
  }
]

Получение списка действий экспертов запланированного экзамена по его идентификатору

Строка запроса GET: /api/v1/exam/{exam_id}/action

Параметры запроса:
Параметр Значение Описание
exam_id Числовой Идентификатор экзамена (часть запроса)
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно

[
  "id": "Идентификатор действия эксперта",
  "a_type": "Тип действия",
  "created_utc": "Дата возникновения действия по гринвичу",
  "expart_id": "Идентификатор эксперта",
  "data": "Данные действия эксперта",
]

Добавление нового действия эксперта

Строка запроса POST: /api/v1/exam/{exam_id}/practice/action

Параметры запроса:
Параметр Значение Описание
exam_id Числовой Идентификатор экзамена (часть запроса)
a_type   Тип действия
data   Данные действия эксперта
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
  • Успешно //Нет данных ответа// }

Получение состояния принимаемого экзамена

Строка запроса GET: /api/v1/exam/{exam_id}/practice/viewstate

Параметры запроса:
Параметр Значение Описание
exam_id Числовой Идентификатор экзамена (часть запроса)
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно

{
  "state": "Состояние принимаемого экзамена",
  "task": "Задание",
  "task_lock": [ "Заблокированное задание" ],
  "wait_experts": [ "Идентиифкатор эксперта" ]
}

Администрирование

Получение статисктики по проведенным экзаменам

Строка запроса GET: /api/v1/admin/stat

Параметры запроса:

Не имеет параметров

Варианты ответа:

Успешно Строковый результат

Получает сведения об экзамене? квалфикации? по идентификатору

Строка запроса GET: /api/v1/admin/test/{skill_id}

Параметры запроса:
Параметр Значение Описание
skill_id Числовой Идентификатор экзамена? квалификации? (часть запроса)
Варианты ответа:

Ошибка 422

{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}

Успешно Строковый результат

Завершение работы МАК

Строка запроса POST: /api/v1/admin/poweroff

Параметры запроса:

Не имеет параметров

Варианты ответа:

Успешно Строковый результат

Синхронизация

Получение состояние синхронизации экзаменов

Строка запроса GET: /api/v1/sync/exams

Параметры запроса:

Не имеет параметров

Варианты ответа:

Успешно Строковый результат

Наверх