Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Ошибки предоставляются в соответствии с спецификацией jsonapi

Внутри массива errors гарантируется наличие status и title.
В случае ошибки 400 также будет добавлен source с указанием параметра и detail с указанием причины ошибки.


Код делится на 3 части:

  1. указание слоя где произошла ошибка
  2. указание объекта с которым произошла ошибка
  3. что именно пошло не так


Кодописание кодаsub codeОписание
01Неопределённые ошибки00неопределённые ошибки.
02


Ошибка при разборе запроса00

Общие ошибки в запросе

errorописание
00Передан не поддерживаемый параметр.
01Достигнут лимит запросов
02Невалидный JSON в запросе
03Некорректный ID в запросе
04Некорректный формат даты
05Некорректное значение HTTP-заголовка
06Отсутствует необходимый HTTP-заголовок
07Требования заголовка Accept* не могут быть удовлетворены сервером
01Ошибка в билинге запроса. (серверная ошибка)
10

Ошибки в запросах к истории

КодОшибка
00история не найдена
01неверный период в запросе агрегированной истории.
02Неверный интервал дат
03


Ошибка при валидации данных00

Общие ошибки

КодОшибка
00

Неверный формат поля

в meta

  • field - название поля с ошибкой
  • value - значение в поле
01

Отсутствует обязательное поле

в мета - список неизвестных полей

02

Передано неизвестное поле

в meta - список неизвестных полей

04

Неверное значение поля

  • field - поле в котором ошибка
05Атрибуты не заданы
06Один из атрибутов должен быть NOT NULL
07Ошибка в фильтре - передано неизвестное поле
08Ошибка в фильтре - синтаксическая ошибка
09Ошибка в фильтре - фильтрация по данному типу объектов не поддерживается.
12

Смена / востановление пароля

КодОшибка
01Клиент не существует
02Email не найден или не является первичным
03Email не уникален
15
Изменение водителя (проверка изменения телефона)
КодОшибка
01Телефоны не принадлежат пользователю
17

Создание / Иземенение Диспетчера.

КодОшибка
01Логин не уникален
02Недопустимые символы в пароле
03Длина пароль
04Совпадает с логином
04


Проверки бизнес правил, проверки уровня доступа к объектам

00

Общие ошибки

КодОшибка
01

Объект не найден

в meta

  • id - идентификатор объекта
  • type - тип объекта
02

Объекты не найдены

в мета

  • ids - список ид объектов
  • type - тип объектов
03Доступ запрещён
04Данный объект уже существует.


10

Изменение / удаление ТС

КодОшибка
01

Нет прав редактировать или удалять ТС

в meta:

  • account_id - идентификатор аккаунта
  • car_id - идентификатор ТС
13

Запрос посещённых геозон

КодОшибка
01Некорректный интервал дат
14

Изменение / Удаление зон

КодОшибка
01Пользователь не имеет прав на редактирование Контрольной зоны
02Пользователь не имеет прав на удаление Контрольной зоны
15

Получение ссылки на видео поток

КодОшибка
01

Устройство оффлайн (не на связи)

02Прямая ссылка на видео не поддерживается
16

Получение видео файла

КодОшибка
01Файл для загрузки не найден
17

Удаление задачи на загрузку видео

КодОшибка
01Не удалось удалить задачу на загрузку видео
19

Создание задачи на загрузку видео

КодОшибка
01Не удалось создать задачу на загрузку видео
21

Диспетчера

КодОшибка
01

Данные верны, но у пользователя отсутвует email подходящий для отправки уведомления, при этом в запросе флаг sendAuthData = true.

22

Группы

КодОшибка
01Пользователь не имеет прав на редактирование группы (только создатель группы может её редактировать)
02Пользователь не имеет прав на удаление группы (только создатель группы может её удалять)
03Группу нельзя удалять (всем пользователям)
23

Погода

КодОшибка
01

Дублирование погоды для ДТП.

Отдаётся при создании погоды для ДТП, если для данного ДТП уже есть пользовательская погода.

24

Создание ТО

КодОшибка
01Дублируется планируемое ТО (только для СБТ)
25

Удаление ТО

КодОшибка
01Запрещено удаление запланированного ТО (только СБТ)
26

Изменение ТО

КодОшибка
01Запрещена смена статуса, если текущий равен done
27

Загрузка фото

КодОшибка
01Загрузка файлов запрещена (сервис квоты файлов не подключен)
02

Недостаточно места на диске (квоты на место)

Данные в  meta

ПолеОписание
file_sizeразмер файла в байтах
space_leftсвободно места в байтах
space_usedиспользовано места в байтах
space_allowedвсего доступно в байтах
28

Топливные карты

КодОшибка
01Топливная карта уже существует
29

Привязка водителей к ТС

КодОшибка
01Привязка водителя к ТС уже существует
30

Создание/Изменение БУ

КодОшибка
01Устройство уже существует
31

Создание / изменение Связки ТС

КодОшибка
01ТС уже связана с другой ТС
32

Ключи водителя

КодОшибка
01Номер ключа существует
33

Параметры отчетов

КодОшибка
01Не задан фильтр при получении параметров заданий
34
Ошибки получения истории
КодОшибка
01История не найдена
02Некорректный интервал дат
35

Изменения списка доступных объекта диспетчера

КодОшибка
01ACL тип не поддерживается
05Ошибка получения / сохранения данных.
Все ошибки являются серверными.
12

Ошибка получения аккаунта

КодОшибка
01Аккаунт не найден
13

Ошибка получение токена

КодОшибка
01Невалидный reset_token
14

Ошбика получения БУ

КодОшибка
01Не найден протокол БУ
15

Ошибка получения истории.

КодОшибка
01Некорректный интервал дат
06

Ошибка получения / сохранения данных.

Все ошибки являются серверными



07Ошибки в include00

Ошибки в данных переданных в поле include

КодОшибка
01Передано неизвестное поле
08Ошибка в поле fields00
КодОшибка
01Передан некорректный параметр в fields
  • No labels