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

ЦОК

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

Экзамены

Сохранение нового ресурса/видеозаписи в хранилище

Строка запроса POST: /api/v1/exam/store

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор экзамена
user_id Числовой Идентификатор пользователя
startedAt Дата и время в формате 'Y-m-d H:i:s' Дата-время начала экзамена
endedAt Дата и время в формате 'Y-m-d H:i:s' Дата-время окончания экзамена
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Получение данных ресурса из хранилища

Строка запроса POST: /api/v1/exam/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "exam_id": "Идентификатор экзамена",
  "status": "Состояние экзамена",
  "stage_name": "Расшифровка состояния сдачи экзамена"
}

Обновление cведений о ресурсе в хранилище

Строка запроса POST: /api/v1/exam/{id}/update

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор экзамена (часть запроса)
user_id Числовой Идентификатор пользователя
startedAt Дата и время в формате 'Y-m-d H:i:s' Дата-время начала экзамена
endedAt Дата и время в формате 'Y-m-d H:i:s' Дата-время окончания экзамена
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление ресурса их хранилища

Строка запроса POST: /api/v1/exam/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Эксперты

Сохранение нового эксперта в хранилище

Строка запроса POST: /api/v1/experts/store

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Получение данных эксперта по его идентификатору

Строка запроса POST: /api/v1/experts/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "id": "Идентификатор эксперта",
  "code": "Код дл авторизации эксперта",
  "is_on": "Вход разрешен",
  "user": [
    {
      "id": "Иднетификатор пользователя",
      "full_name": "ФИО пользователя"
    }
  ],
  "units": [
    {
      "id": "Идентификатор ЦОК для проведения экзамена",
      "name": "Наименование ЦОК",
      "is_operator": "Является оператором квалификации",
      "is_main": "Является основным для квалификации",
    }
  ],
  "skills": [
    {
      "id": "Идентификатор квалификации",
      "name": "Наименование квалификации",
      "code": "Код квалификации",
      "is_tech": "Является технической",
      "is_prof": "Является профессиональной"
    }
  ]
}

Обновление данных эксперта по его идентификатору

Строка запроса POST: /api/v1/experts/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление эксперта по его идентификатору

Строка запроса POST: /api/v1/experts/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Временные интервалы

Сохранение нового интервала в хранилище

Строка запроса POST:/api/v1/intervals/store

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Получение данных интервала по его идентификатору

Строка запроса GET: /api/v1/intervals/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "data": [
    {
      "id": "Идентификатор интервала",
      "start": "Дата-время начала экзамена 'строка Y-m-d H:i:s'",
      "end": "Дата-время окончания экзамена [строка Y-m-d H:i:s]",
      "tz": "Часовой пояс",
      "room_id": "Код учебного класса/ЭП",
      "skill_id": "Код квалификации",
      "skill_name": "Наименование квалификации",
      "stage_id": "Код стадии сдачи экзамена",
      "stage_name": "Расшифровка состояния сдачи экзамена",
      "stage_time": "Время сохранения состояния",
      "mac": "Идентификатор МАк или null",
      "experts": [
        {
          "id": "Идентификатор эксперта",
          "code": "Код входа эксперта",
          "user_id": "Идентификатор пользователя",
          "surname": "Фамилия эксперта",
          "name": "Имя эксперта",
          "patronymic": "Отчество эксперта"
        }
      ],
      "exams": [
        {
          "id": "Идентификатор экзамена",
          "user_id": "Идентификатор пользователя [соискателя] для которого проводится экзамен",
          "surname": "Фамилия эксперта",
          "name": "Имя эксперта",
          "patronymic": "Отчество эксперта",
        }
      ]
    }
  ]
}

Обновление данных интервала по его идентификатору

Строка запроса POST: /api/v1/intervals/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление интервала по его идентификатору

Строка запроса POST: /api/v1/intervals/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Вопросы

Сохранение нового вопроса в хранилище

Строка запроса POST: /api/v1/questions/store

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

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

Строка запроса GET: /api/v1/questions/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "id": "Идентификатор блока вопросов",
  "name": "Наименование блока вопросов",
  "skill_id": "Идентификатор квалификации",
  "questions": [
    {
      "id": "Идентификатор вопроса",
      "text": "Текст вопроса",
      "img": "Ссылка на изображение к вопросу",
      "question_type_id": "Идентификатор типа вопроса",
      "question_type": "Расшифровка типа вопроса",
      "one": "Признак единственного ответа",
      "variants": [
        {
          "id": "Идентификатор варианта ответа",
          "text": "Текст варианта ответа",
          "img": "Ссылка на изображение к варианту ответа",
          "conf": "Подтверждение выбора варианта вопроса?",
          "ans": "Ответ к варианту вопроса или признак правильного ответа?"
        }
      ]
    }
  ]
}

Обновление вопроса по его идентификатору

Строка запроса POST: /api/v1/questions/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление вопроса по его идентификатору

Строка запроса POST: /api/v1/questions/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Квалификации

Сохранение новой квалификации в хранилище

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор квалификации
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Получение данных квалификации по её идентификатору

Строка запроса GET: /api/v1/skills/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "id": "Идентификатор квалификации",
  "name": "Наименование квалификации",
  "code": "Код квалификации",
  "created_at": "Дата-время создания квалификации",
  "updated_at": "Дата-время обновления квалификации",
  "acts": [
    {
      "id": "Идентиифкатор документа",
      "name": "Наименование документа",
      "file": "Ссылка на файл документа",
      "info": "Сведения о документе"
    }
  ]
}

Обновление данных квалификации по её идентификатору

Строка запроса POST: /api/v1/skills/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление квалификации по её идентификатору

Строка запроса POST: /api/v1/skills/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Состояния

Сохранение нового состояния в хранилище

Строка запроса POST: /api/v1/states/store

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор состояния
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

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

Строка запроса GET: /api/v1/states/{id}/show

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

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор состояния*
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Обновление состояния по его идентификатору

Строка запроса POST: /api/v1/states/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление состояния по его идентификатору

Строка запроса POST: /api/v1/states/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Модули

Сохранение нового ЦОК в хранилище

Строка запроса POST: /api/v1/units/store

Параметры запроса:
Параметр Значение Описание
id Числовой Идентификатор ЦОК
Варианты ответа:

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Получение данных ЦОК по его идентификатору

Строка запроса POST: /api/v1/units/{id}/show

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "id": "Идентификатор ЦОК",
  "code": "Код ЦОК",
  "name": "Краткое наименование ЮЛ ЦОК",
  "full_name": "Полное наименование ЮЛ ЦОК",
  "inn": "ИНН ЦОК",
  "ogrn": "ОГРН ЦОК",
  "legal_address": "Юридический адрес",
  "kpp": "Код причины постановки на учет",
  "region_id": "Код региона ИКАО",
  "region": "Наименование региона",
  "places": [
    {
      "id": "Идентификатор площадки",
      "name": "Наименование площадки",
      "timezone": "Часовой пояс",
      "city": "Город",
      "address": "Адрес площадки",
      "rooms": [
        {
          "id": "Идентификатор помещения",
          "name": "Наименование помещения",
        }
      ]
    }
  ]
}

Обновление данных ЦОК по его идентификатору

Строка запроса POST: /api/v1/units/{id}/update

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}

Удаление ЦОК по его идентификатору

Строка запроса POST: /api/v1/units/{id}/destroy

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

Ошибка

{
  "error": "Текст ошибки",
  "success": false
}

Успешно

{
  "success": true
}
Наверх