Все запросы (исключение составляют только запросы на получение html-страниц) принимают и возвращают данные в JSON-формате.
В случае успешного выполнения возвращается только HTTP-ответ.
Если в процессе выполнения происходит ошибка, то возвращается поле status следующего формата:
Пример поля status
"status": {
"code": 10127,
"description": "Password strength validation: password too short",
"message": "Bad Request",
"status": 400
}
Описание параметров:
- code — код возврата сервиса на недопустимую операцию;
- description — описание недопустимой операции;
- message — дублирование описания HTTP-ответа;
- status — дублирование кода HTTP-ответа.
Коды ошибок и их описание:
| Код возврата сервиса | Текст ошибки для интерфейса | |
|---|---|---|
| 401 | Пользователь не авторизован | User unauthorized |
| 10101 | Продукт с указанным номером уже существует | Product with the same number and modification already exists |
| 10102 | Невозможно отредактировать продукт со статусом "В продаже" | Attempt to edit the product that has been sold yet |
| 10103 | Невозможно удалить продукт со статусом "В продаже" | Attempt to remove the product that has been sold yet |
| 10104 | Компонент с указанным номером уже существует | Feature with the same number already exists |
| 10105 | Невозможно удалить компонент, входящий в состав хотя бы 1 продукта | Attempt to delete the feature that was assigned to one or more products |
| 10106 | Указано некорректное ограничение времени работы лицензии | Specified rent time and subscription days at the same time |
| 10107 | Невозможно отредактировать заказ со статусом "Выполнен" | Attempt to edit the order that has been submitted yet |
| 10108 | Невозможно удалить заказ со статусом "Выполнен" | Attempt to remove the order that has been submitted yet |
| 10109 | Невозможно исключить из продукта обязательный компонент | Attempt to exclude a feature that is not marked as excluded |
| 10110 | Невозможно удалить продукт, указанный хотя бы в 1 заказе | Attempt to delete the product that was assigned to one or more orders |
| 10111 | Невозможно удалить компонент, входящий в состав хотя бы 1 продукта | Attempt to delete the feature from product that was assigned to one or more orders |
| 10112 | Невозможно создать заказ с продуктом без компонентов | Attempt to sumbit order with a product that does not have features |
| 10113 | Операция возможна только для заказов на обновление лицензии | Operation allowed only for update orders |
| 10114 | Указанный серийный номер не найден | Serial number doesn't present in database |
| 10115 | Выбранный компонент уже добавлен в продукт | Feature already exists in product |
| 10119 | Некорректный серийный номер | Invalid serial number |
| 10120 | Email пользователя не подтвержден | User email unverified |
| 10121 | Пользователь не зарегистрирован | User with such username is not registered |
| 10123 | Зафиксирована подозрительная активность | Throttling detected |
| 10124 | Имя пользователя слишком короткое | Username name too short |
| 10125 | Некорректный email | Incorrect email address |
| 10126 | Пользователь с таким именем уже существует | Username already exists |
| 10127 | Пароль слишком простой | Password strength validation failed |
| 10128 | Пароли не совпадают | Confirmation password doesn't match |
| 10129 | Запрашиваемый объект отсутствует | The requested object was not found in the database |
| 10130 | Продукт не содержит ни одного компонента | Product does not contain feature |
| 10131 | Модификация невозможна | Can't modify yourself |
| 10135 | Недостаточно прав для выполнения операции | Insufficient rights for this operation |
| 10136 | Невозможно добавить пользователя с ролью "администратор" | Can't add one more user with admin role |
| 10137 | Невозможно удалить покупателя, указанного хотя бы в 1 заказе | Attempt to delete the customer that was assigned to one or more orders |
| 10138 | Невозможно создать заказ на обновление лицензии | No valid order to create update order |
| 10139 | Невозможно добавить продукт с другими кодами доступа | Addition of the product with different access codes to the order is not allowed |