Skip to content

Изменение категории

Метод служит для обновления информации о категориях сотрудников.


URL

PUT https://rest.lksup.ru/v1/category/{idCategory}

Описание

Метод возвращает результат обновления категории.

Для выполнения запроса необходимо предоставить:
- Параметры категории — информацию о категории.
- Авторизационные данные — JWT access токен. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)

Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно. Подробнее ознакомиться с информацией о шифровании можно по ссылке


Структура запроса

В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. В тело запроса помещаются, предварительно зашифрованные данные о категории. idCategory передается в качестве path параметра

Пример запроса

Формат запроса:

PUT https://rest.lksup.ru/v1/category/{idCategory}

{
  "nameCategory": "someth_name"
}

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

Параметр Тип Описание Обязательный Шифрование
idCategory uuid Идентификатор категории в сервисе СУП Да Да
nameCategory string Наименование категории Да Да

Структура ответа

Пример успешного ответа - код 200

{
  "nameCategory": "someth_name",
  "idCategory": "fb9a524d-a715-451d-8636-40cefe9016e9"
}

Параметры успешного ответа

Параметр Тип Описание
nameCategory string Наименование категории
idCategory uuid Идентификатор категории в сервисе СУП

Пример ответа с ошибкой

Ответы с ошибкой могут быть двух видов.

Пример ответа для кода состояния 422

{
  "data": [{
            "field":"string",
            "message":"string"
            },
            {
            "field":"string",
            "message":"string"
            }]
}

Пример ответа для кодов состояния 4хх, за исключением 422

{
  "message": "string"
}

Параметры ответа с ошибкой

Параметр Тип Описание
field string Наименование поля, в котором была допущена ошибка
message string Текстовое описание ошибки

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

Статус Описание
401 Не авторизован. Токен не прошел валидацию
404 Категория idCategory не найдена
409 Категория nameCategory уже существует
422 Передано некорректное значение