Коды результатов
Коды HTTP-статусов
Для обозначения результата выполнения вызова используются HTTP статусы ответа:
- 1хх – информация уровня протокола HTTP.
- 2xx – успешное выполнение.
- 3хх – перенаправление.
- 4хх – ошибка клиента.
- 5хх – ошибка сервера.
| Код | Результат | Описание | Фатальность |
|---|---|---|---|
| 200 | OK | Успешное выполнение. | - |
| 201 | CREATED | Успешное выполнение (ресурс создан, например, успешно создана задача) | - |
| 204 | NO CONTENT | Успешное выполнение (ресурс обновлен, например, успешно изменены параметры задачи или задача была успешно удалена) | - |
| 301 | MOVED PERMANENTLY | Запрошенный ресурс был окончательно перемещен на указанный URI. | Да |
| 302 | FOUND | Запрошенный ресурс был временно перемещен на другой URL. | Нет |
| 400 | BAD REQUEST | Ошибка в запросе. Нужно проверить запрос на корректность формата и передаваемых данных. | Нет |
| 401 | UNAUTHORIZED | Требуется аутентификация: не передан токен или передан невалидный токен. | Да |
| 403 | FORBIDDEN | Нет доступа. Для данного Пользователя нет прав на объект (например, у Пользователя нет прав на изменение данных другого Сотрудника) | Да |
| 404 | NOT FOUND | Запрашиваемый ресурс не найден, нужно проверить URI. | Да |
| 405 | METHOD NOT ALLOWED | Метод не может быть использован (например, указан неверный метод DELETE вместо POST или GET). | Да |
| 500 | INTERNAL SERVER ERROR | Общий сбой на стороне сервера. | Да |
| 501 | NOT IMPLEMENTED | Указанный запрос не может быть обработан. | Да |
| 502 | BAD GATEWAY | Ошибка обработки запроса Услугой. | Да |
| 503 | SERVICE UNAVAILABLE | Временный сбой на стороне сервера. Следует повторить запрос через определенное время (не менее 5 секунд). | Нет |
| 504 | GATEWAY TIMEOUT | Тайм-аут обработки запроса Услугой. | Да |
Коды результатов функций Платформы
| Код | Результат | Описание | Фатальность |
|---|---|---|---|
| 0 | OK | Успешное завершение функции | - |
| 1 | USER_UNAUTHORIZED | Пользователь не авторизован. | Да |
| 2 | BAD_REQUEST | Ошибка в запросе. Нужно проверить запрос на корректность формата и передаваемых данных. | Да |
| 3 | INTERNAL_SERVER_ERROR | Общий сбой на стороне сервера. | Да |
| 4 | SUBSCRIBER_EXTERNAL_ID_EXISTS | Сотрудник с таким внешним ИД уже существует. | Да |
| 5 | SUBSCRIBER_ALLOWED_OVERTIME_EXCEEDED | Превышено разрешенное время переработки для Сотрудника. | Да |
| 6 | EMPTY_TASK_LIST | Указан пустой список задач. | Да |
| 7 | GROUP_IS_NOT_RELATED_TO_CUSTOMER | Указанная группа не принадлежит компании. | Да |
| 8 | PERMISSION_REQUEST_CREATION_IS_NOT_ALLOWED | Запрещено создание запросов на добавление Сотрудников | Да |
| 9 | NOT_EMPTY_GROUP | Группа не пустая | Да |
| 10 | PERMISSION_ERROR | Ошибка прав доступа. Код также возвращается, если в методе обновления или редактирования задач был передан пользовательский статус, переводить в который пользователь не имеет прав. | Да |
| 11 | UNKNOWN | Неизвестная ошибка | Да |
| 12 | NO_SUCH_SUBSCRIBER | Сотрудник не найден | Да |
| 13 | WRONG_SUBSCRIBER_CREATION_TYPE | Некорректный источник добавление Сотрудника | Да |
| 14 | NOT_ENOUGH_TIME_PASSED_TO_DELETE | Для удаления Сотрудника не прошло достаточно времени с момента добавления | Да |
| 15 | INVALID_TASK_STATUS | Указан несуществующий статус задачи | Да |
| 16 | INVALID_TASK_PRIORITY | Указан несуществующий приоритет задачи | Да |
| 17 | INVALID_COMMENT_POLICY | Указано неверное значение обязательности комментария | Да |
| 18 | TASK_NOT_FOUND | Задача не найдена | Да |
| 19 | NO_SUBSCRIBER_GROUP_FOUND | Группа Сотрудников не найдена | Да |
| 20 | WRONG_PARENT_GROUP | Некорректная родительская группа | Да |
| 21 | GROUP_NAME_EXISTS | Группа с таким именем уже существует. | Да |
| 22 | TITLE_IS_NEEDED | Не задано название | Да |
| 23 | WRONG_ADDRESS | Некорректный адрес | Да |
| 25 | INVALID_COMPETENCE | Компетенция не существует | Да |
| 26 | GROUP_NOT_SPECIFIED | Группа не указана | Да |
| 27 | INVALID_GROUP | Группа не существует | Да |
| 28 | NAME_IS_NOT_UNIQUE | Имя уже существует | Да |
| 29 | INVALID_WORK_SCHEDULE | Данный график работы не существует | Да |
| 30 | WRONG_WORK_SCHEDULE_INTERVAL | Некорректно указан период рабочего графика | Да |
| 31 | INVALID_TASK_SERVICE_TIME | Указано несуществующее время выполнения задачи | Да |
| 32 | INVALID_TASK_START_INTERVAL | Указано несуществующее время начала выполнения задачи | Да |
| 33 | INVALID_TASK_START_DATE | Некорректно указана дата начала выполнения задачи. | Да |
| 34 | INVALID_CUSTOM_FIELD_FORM_TEMPLATE_ID | Указан несуществующий ИД шаблона форм. | Да |
| 35 | INVALID_TASK_OBJECT_ID | Указан несуществующий ИД объекта задачи. | Да |
| 36 | EMPTY_TASK_TITLE | Указано пустое название задачи | Да |
| 37 | INVALID_TASK_SUBSCRIBER_ID | Указан несуществующий ИД aбонента в задаче | Да |
| 38 | INVALID_TASK_ID | Указан несуществующий ИД задачи | Да |
| 39 | WRONG_WORK_SCHEDULE_EXCEPTION_SUBSCRIBER | Некорректно указан Сотрудник для исключения из графика | Да |
| 40 | OBJECT_ASSOCIATED_TO_SIGNAL | К объекту привязано событие | Да |
| 41 | EMPTY_SUBSCRIBER_NAME | Имя Сотрудника не указано | Да |
| 42 | WRONG_DATE | Некорректно указаны даты | Да |
| 43 | NO_MAP_OBJECT_FOUND | Объект не найден | Да |
| 44 | NO_ZONE_GROUP_FOUND | Группа зон не найдена | Да |
| 45 | NO_ZONE_FOUND | Зона не найдена | Да |
| 46 | MAP_OBJECT_EXISTS | Объект с таким именем уже существует | Да |
| 47 | ZONE_NAME_EXISTS | Зона с таким именем уже существует | Да |
| 48 | ZONE_GROUP_NAME_EXISTS | Группа зон с таким именем уже существует | Да |
| 49 | COMPETENCE_NAME_EXISTS | Компетенция с таким именем уже существует | Да |
| 50 | TASKS_NOT_FOUND | Задачи не найдены | Да |
| 51 | EMPTY_LIST | Передан пустой список | Да |
| 52 | NULL_ARGUMENT | Указан пустой обязательный параметр | Да |
| 53 | NO_MAP_OBJECT_GROUP_FOUND | Группа объектов не найдена | Да |
| 54 | ZONE_EMPTY_NAME | Не указано название гео-зоны | Да |
| 55 | LAST_GROUP | Нельзя удалить последнюю группу | Да |
| 56 | EMPTY_SUBSCRIBER_LIST | Передан пустой список Сотрудников | Да |
| 57 | ALL_TASKS_NOT_IN_PLANNING_INTERVAL | Задачи находятся вне интервала планирования | Да |
| 58 | PLANNING_NOT_CREATED | Планирование не создано | Да |
| 59 | INCORRECT_PLANNING | Некорректное планирование. Для уточнения причины необходимо обратиться в техническую поддержку на support@mpoisk.ru | Да |
| 60 | ERROR_IN_PLANNING_SERVICE | Ошибка планирования. Для уточнения причины необходимо обратиться в техническую поддержку на support@mpoisk.ru | Да |
| 61 | WRONG_SUBSCRIBER | Указан некорректный ИД Сотрудника | Да |
| 62 | EMPTY_COMPETENCE_NAME | Не указано название компетенции | Да |
| 63 | NO_SUCH_SUBSCRIBERS | Абоненты не найдены | Да |
| 64 | CUSTOMER_NOT_FOUND | Компания не найдена | Да |
| 65 | NO_JOB_FOUND | Заявка не найдена | Да |
| 66 | COUNT_LIMIT_EXCEEDED | Превышено максимальное количество элементов в запросе (200) | Да |
| 67 | INVALID_NUMBER_OF_ELEMENTS | Указано некорректное количество элементов, по которым нужно получить данные (максимальное количество — 1000) | Да |
| 82 | WRONG_COMPENCES | Некорректно указаны компетенции | Да |
| 126 | TOO_MANY_CHECKLISTS | Передано некорректное количество чек-листов (больше 1) | Да |
| 127 | CANNOT_EDIT_CHECKLIST_WHEN_TASK_IS_NOT_NEW | Редактирование чек-листа недоступно для данного статуса задачи | Да |
| 128 | NO_CHECKLIST_TEMPLATE_IDS_PASSED | Не переданы ИД шаблонов чек-листов | Да |
| 129 | GENERAL_SAVE_CHECKLIST_ERROR | Ошибка сохранения чек-листа | Да |
| 142 | INVALID_PREFERRED_POSITION_IN_ | Указана некорректная позиция задачи в маршруте | Да |
| 175 | ACTIVE_TASK_ALREADY_EXISTS | У Сотрудника уже есть активная задача в пользовательском статусе «В пути» или «В работе», перевод задачи в один из этих статусов с помощью метода обновления или редактирования задачи недоступен. | Да |
| 222 | TASK_CUSTOM_STATUS_ACTIVE_NOT_ALLOWED_FOR_PLANNING | Невозможно перебронировать задачу в статусе с признаком «Активен» | Да |
| 223 | TASK_CUSTOM_STATUS_IS_NOT_ALLOWED_FOR_PLANNING | Невозможно перебронировать задачу в статусе, не позволяющем брать задачу в планирование | Да |
| 224 | TASK_IS_FIXED_NOT_ALLOWED_FOR_PLANNING | Невозможно обновить бронирование для зафиксированной задачи | Да |
| 225 | REQUEST_DATE_TIME_INCONSISTENT_FORMAT | Разные форматы времени в запросе | Да |
| 256 | INVALID_TEAM_SETTINGS | Некорректно указаны настройки бригад | Да |
Статусы планирования задач
| Статус планирования задач | Описание |
|---|---|
| OK | Успешное создание планирования задач |
| CANCELED | Планирование было остановлено |
| EMPTY_SUBSCRIBER_LIST | Передан пустой список Сотрудников |
| EMPTY_TASK_LIST | Передан пустой список задач |
| PLANNING_DATE_NOT_SPECIFIED | Передана пустая дата планирования |
| TASKS_NOT_FOUND | Задачи не найдены |
| SOME_TASKS_NOT_FOUND | Часть задач не найдена |
| NO_PERMISSION_ON_SUBSCRIBER | Отсутствуют права на Сотрудника |
| NO_PERMISSION_ON_TASK | Отсутствуют права на задачу |
| NOT_COMPLETED | Распределение задач еще не готово |
| SERVICE_ERROR | Ошибка планирования. Для уточнения причины необходимо обратиться в техническую поддержку на support@mpoisk.ru. |
| SYSTEM_ERROR | Для уточнения причины ошибки необходимо обратиться в техническую поддержку на support@mpoisk.ru |
| REQUEST_LIMIT_EXCEEDED | Превышен дневной лимит запросов на построение маршрута с пробками (routerType 3). Попробуйте построить маршрут без учета пробок, передав значение 2 в routerType. |
Ошибки назначения задач при планировании
| Ошибка назначения задачи | Описание |
|---|---|
| ОК | Задача назначена. |
| TASK_NOT_FOUND | Задача не найдена. |
| NOT_IN_PLANNING_INTERVAL | Задача не попадает в интервал планирования. |
| NO_PERMISSION_ON_SUBSCRIBER | Отсутствуют права на Сотрудника. |
| NO_PERMISSION_ON_TASK | Отсутствуют права на задачу. |
| LOCATIONS_PROVIDER_IS_NOT_INITIALIZED | Не удалось определить местоположение Сотрудника. |
| USER_NOT_FOUND | Пользователь не найден. |
| NO_APPLICABLE_SUBSCRIBERS | Нет подходящих для планирования Сотрудников. |
| NO_APPLICABLE_TASKS | Нет подходящих для планирования задач. |
| SUBSCRIBER_NOT_FOUND | Сотрудник не найден. |
| NO_WORKING_HOURS | График работы не задан для Сотрудника в гео-зоне задачи. |
| SUB_HAS_FINISHED_WORKING_SHIFT | Нет свободного времени у Сотрудника, его рабочий день закончен. |
| SUB_HAS_ASSIGNMENTS_AFTER_WORKING_SHIFT | У Сотрудника есть назначенные задачи после окончания рабочего дня. |
| WORK_ORDER_TASK_NOT_FOUND | Не найден порядок задач. |
| SUB_HAS_NO_LOCATION | Отсутствует информация о местоположении Сотрудника. |
| SUB_HAS_NO_ZONE | Сотрудник не привязан ни к одной гео-зоне. |
| TASK_START_TIME_BEFORE_SERVICE_TIME | Время начала задачи раньше времени выполнения. |
| TASK_WITHOUT_LOCATION | У задачи отсутствуют координаты или адрес. |
| TASK_NOT_IN_SESSION_ZONE | Задача не попадает ни в одну гео-зону. |
| TASK_ZONE_WORKSCHEDULE_OVERFLOWED | В гео-зоне задачи у Сотрудников нет свободного времени. |
| TASK_ZONE_NO_SUB_WITH_WORKSCHEDULE | В гео-зоне отсутствуют Сотрудники с графиком работы. |
| TASK_ZONE_NO_SUB | К гео-зоне задачи не привязан ни один Сотрудник. |
| TASK_COMPETENCES_NOT_COVERED | Ни один Сотрудник не подходит по всем компетенциям задачи. |
| DEADLINE_IS_IGNORED | Крайний срок выполнения задачи раньше времени начала выполнения задачи или времени, когда задача может быть выполнена. |
| USER_WITHOUT_PERMISSION_FOR_TASK | У Пользователя нет прав на задачу. |
| ROUTE_NOT_EXISTS | Маршрут не существует. |
| NO_SUB_WITH_FREE_WORK_SCHEDULE_FOR_TASK | У Сотрудников нет свободного времени для выполнения задачи. |
| TASK_NOT_ACCESSIBLE | Невозможно построить маршрут до задачи. |
| NO_SUB_WITH_COMPETENCES_AMOUNT | Невозможно назначить задачу с указанными компетенциями: недостаточно ресурсов. |
| ALL_SUBS_REACHED_DISTANCE_LIMIT | Превышена максимальная дистанция маршрута. |
| TASK_NOT_PLANNED_WITH_CURRENT_SETTINGS | Не удалось распределить задачи по текущим настройкам планирования. |
| CANCELED | Планирование отменено. |
| FAILED_TO_SOLVE_PLANNING | Ошибка планирования, которая может быть возвращена в функции получения результата планирования. Для уточнения причины ошибки необходимо обратиться в техническую поддержку на support@mpoisk.ru. |
| REQUEST_LIMIT_EXCEEDED | Превышен дневной лимит запросов на построение маршрута с пробками (routerType 3). Попробуйте построить маршрут без учета пробок, передав значение 2 в routerType. |
| TIME_WINDOW_UNREACHABLE | Недостижимое временное окно у задачи. |
Коды результатов запросов местоположения
| Код | Описание |
|---|---|
| 0 | Запрос выполнен успешно |
| 1 | Определение местоположения невозможно по техническим причинам. Сотрудник находится в зоне действия новой базовой станции |
| 5 | Сотрудник недоступен или находится вне зоны действия сети |
| 201 | Сотрудник недоступен или находится вне зоны действия сети |
| 204 | Определение местоположения невозможно по техническим причинам |
| 503 | Для Сотрудника не настроена услуга SMS |
| 504 | Сотрудник заблокирован |
| 505 | Сотрудник находится в метро |
| 510 | Сотрудник находится в роуминге |
| 585 | Невозможно определить местонахождение |
| 588 | Превышена максимальная частота запросов, разрешенная для данного тарифа |
| 595 | От устройства не получены GPS-координаты |
| 906 | Пользователь отозвал право определять своё местоположение |
| 3513 | Превышено максимальное количество запросов в день на время тестирования услуги |
| 100000 | Превышено количество запросов в тестовом режиме |