Метод PATCH /openapi/v1/user/:userId

Внесение изменений в данных о пользователе. Перемещение сотрудника компании в другую учебную группу.

Запрос

Заголовок:

• Authorization – api-токен компании.

Параметр:

• userId – тип string – Идентификационный код конкретного пользователя, которого перемещают в другую группу.

  Должен соответствовать критериям:

  • длина показателя 24 символа;
  • только строчные буквы.

Пример запроса: /openapi/v1/user/1ab2457896abcc1234567891

Тело

Формат – JSON.

• groupId – тип string – ID группы, куда должен быть перемещен сотрудник компании.

  Соответствует показателю ID метода /openapi/v1/groups.

  Показатель должен соответствовать критериям:

  • длина показателя 24 символа;
  • только строчные буквы.
• fullName – тип string – полное имя сотрудника.
• shortName – тип string – сокращенное имя сотрудника.
• email – тип string – адрес электронной почты сотрудника.

Пример тела запроса: { "groupId": "1ab2457896abcc1234567891", fullName : "Marvin John Mims" shortName : "Marvin Mims" email : "mims@mail.com" }

Ответ

JSON содержащий массив данных по каждому пользователю.

• userId – тип string – идентификационный код присвоенный пользователю.
• currentGroup – тип object – массив данных о текущей группе пользователя.

  Формируется в формате:

  {

  id,name

  }

  где:

  • id – тип string – идентификационный ключ текущей группы;
  • name – тип string – наименование текущей группы.
• previousGroup – тип object – массив данных о предыдущей группе пользователя.

  Формируется в формате:

  {

  id,name

  }

  где:

  • id – идентификационный ключ предыдущей группы;
  • name – наименование предыдущей группы.
• currentFullName – тип string – данные о текущем полном имени сотрудника.

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

• previousFullName – тип string – данные о предыдущем полном имени сотрудника.

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

• currentShortName – тип string – данные о текущем сокращенном имени сотрудника.

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

• currentShortName – тип string – данные о предыдущем сокращенном имени сотрудника.

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

• currentEmail – тип string – данные о текущем адресе электронной почты сотрудника.

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

• previousEmail – тип string – данные о предыдущем адресе электронной почты сотрудника.

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

  Пример ответа: { userId : "1ab2457896abcc1234567891", "currentGroup" : {id" : "60e050803050c0704080a0e6", "name" : "Rischio ridotto"}, "previousGroup" : {id" : "61e151813151c1714181a1e6", "name" : "Rischio elevato"}, "currentFullName" : "Marvin John Mims", "previousFullName" : "Marvin Jon Mims", "currentShortName" : "Marvin Mims", "previousShortName" : "Marvin", "currentEmail" : "mims@mail.com", "previousEmail" : "johnmims@mail.com" }

Возможные ошибки:

• 200 – successful – корректное завершение работы;
• 400 – Bad Request – недопустимый запрос. Клиент не должен повторять этот запрос без изменений;
• 400 – user-email-already-exists-in-company – такой адрес электронной почты уже используется в компании;
• 401 – common-unauthorized – ошибка авторизации;
• 402 – PAYMENT_REQUIRED – лицензия не активна;
• 403 – forbidden – у токена нет прав на этот метод;
• 404 – User not found – передан некорректный email;
• 404 – Group not found – передан некорректный Id группы; 
• 409 – User status not supported for this operation – запрос не может быть выполнен, пользователь в статусе, в котором данную операцию выполнить невозможно;
• 409 – User's education plan is calculate – запрос не может быть выполнен из-за проведения расчета обучения пользователя;
• 409 – cannot-join-group – сотрудник не может быть перемещен в группу;
• 500 – internal-server-error – внутренняя ошибка сервера.

В начало