Создание категории
Метод служит для добавления новых категорий сотрудников.
URL
POST https://rest.lksup.ru/v1/category
Описание
Метод возвращает идентификатор (idCategory), созданной в системе категории.
Для выполнения запроса необходимо предоставить:
- Параметры категории — информацию о категории.
- Авторизационные данные — JWT access токен.
- X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно. Подробнее ознакомиться с информацией о шифровании можно по ссылке
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. В тело запроса помещаются, предварительно зашифрованные данные о категории.
Пример запроса
Формат запроса:
POST https://rest.lksup.ru/v1/category
Тело запроса
{
"nameCategory": "someth_name"
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
nameCategory |
string | Наименование категории | Да | Да |
Структура ответа
Пример успешного ответа - код 201
{
"nameCategory": "someth_name",
"idCategory": "fb9a524d-a715-451d-8636-40cefe9016e9"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
nameCategory |
string | Наименование категории |
idCategory |
uuid | Идентификатор категории в сервисе СУП |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data": [{
"field":"string",
"message":"string"
},
{
"field":"string",
"message":"string"
}]
}
Пример ответа для кодов состояния 4хх
{
"message": "string"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
field |
string | Наименование поля, в котором была допущена ошибка |
message |
string | Текстовое описание ошибки |
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Токен не прошел валидацию |
| 409 | Категория nameCategory уже существует |
| 422 | Передано некорректное значение |