Описание API > Обработка ошибок

Сообщения об ошибке в WebSocket

В момент возникновения ошибки Voice2Med Client отправляет уведомление, описываемое классом ErrorInfo.

Класс описания возникшей ошибки
Поле	Тип поля	Обязательное	Описание
Text	String	Да	Текстовое сообщение об ошибке
DebugText	String	Нет	Расширенное описание ошибки

При подключении ИС к Voice2Med Client сообщение имеет код 5, при подключении ИС к Dictation Server — 205.

Например, попытка загрузки некорректного описания формы в Voice2Med Client вернёт ошибку.

{
  "MessageType": 5,
  "Data": {
  "Text": "Некорректный формат загружаемых метаданных"
  }
}

А попытка загрузки некорректного описания формы в Dictation Server вернёт ошибку.

{
    "MessageType": 205,
    "Data": {
        "Text": "Внутренняя ошибка сервера, попробуйте выполнить операцию позже",
        "DebugText": "Newtonsoft.Json.JsonReaderException: JsonToken EndObject is not valid for closing JsonType Array."
    }
}

Сообщения об ошибке в Rest (http)

Rest API вернёт ошибку, если с вашими вызовами что-то пойдет не так. Каждая ошибка имеет http-код, а также возвращает тип ошибки и краткое объяснение при возникновении ошибки.

При использовании любого API помните, что ошибки и исключения (например, проблемы с подключением к серверу или простои) редко, но все же случаются. Внимательно следите за ошибками.

Причины ошибок:

•Коды 4xx указывают на ошибку в запросе. Если вы получили в ответ ошибку 4xx, приведенный ниже глоссарий ошибок поможет понять причину неполадки.

•Коды 5xx указывают на проблему со стороны Voice2Med. Если вы получаете в ответ ошибку 5xx, то рекомендуем проверить, не возникли ли какие-либо общесистемные проблемы в Voice2Med.

Глоссарий распространённых ошибок http

Ошибка	Описание
400	Такой ответ можно получить, если Voice2Med не смог правильно отреагировать на ваш запрос. Например, нарушены правила синтаксиса. Повторный запрос не следует отправлять до тех пор, пока ошибка не будет исправлена. Некоторые из наиболее частые причины: Bad Request (Неверный запрос). Общий тип ошибки, связанный с невозможностью обработки запроса, и обычно в сообщении содержится пояснение. Invalid Resource (Недопустимый ресурс). Отправленный текст POST не прошел нашу проверку ввода. Эта ошибка может включать дополнительное свойство «ошибки» со списком проблем проверки. Invalid Action (Недопустимое действие). Запрошенное действие недействительно для вызываемого ресурса. Возвращается, когда вы пытаетесь получить доступ к действию для ресурса, который не поддерживает это действие. JSON Parse Exception (Исключение анализа JSON). JSON, отправленный в тексте запроса, не является допустимым JSON.
403	Forbidden (Запрещено) Voice2Med отказывается обработать запрос, потому что у вас нет прав на просмотр содержимого: не имеете доступа, либо ваш уровень не разрешает доступ к конечной точке.
404	Not Found (Ресурс не найден). Вы пытаетесь запросить ресурс, который не существует. Например, случайно ошиблись при вводе узлов.
405	Method Not Allowed (Метод запрещён). Указанный в запросе метод нельзя использовать. Ошибка обычно возникает из-за того, что конечная точка не поддерживает HTTP-метод запроса. Для решения проблемы узнайте, какие методы разрешены для каждого ресурса.
414	URI Too Long (Слишком длинный URI). URI превышает максимально допустимую длину или имеет неверный формат.
422	Unprocessable Entity (Необрабатываемый запрос). Синтаксис запроса правильный, но из-за логической ошибки сервер не может его выполнить.
500	Internal Server Error (Внутренняя ошибка сервера). Во время обработки запроса произошла внутренняя ошибка. Voice2Med столкнулся с ситуацией, которую он не знает, как обработать.