Каждый вызов API возвращает либо объект JSON с запрошенной информацией, либо объект с парой Имя/Значение, отражающей состояние запрошенной операции, которая также может содержать сообщение об ошибке с описанием.

Имя/значение отражает правильное выполнение вызова:

  • «Успех»: правда — В случае, если запрос был правильным (принят) и выполнен должным образом.
  • «Успех»: ошибка — ошибка произошла.

Второе имя/значение приносит короткий описательный текст на любой результат:

  • «Результат»: «Хорошо» — В случае, если запрос был правильным (принят) и выполнен должным образом.
  • «ОшибкаВзрачение»: «описание текстовой ошибки» — Если произошла ошибка.
Пример успешного реагирования:

{
«Success»: true,
«Result»: «Фильтр 1110 был обновлен
«}

Примеры реагирования на ошибки:

{
«Success»: false,
«ErrorDescription»: [
«Не удалось войти в систему! Проверьте свое имя пользователя или пароль»
] }

{ «Success»: false, «ErrorDescription»: «Неверный идентификатор истории» }

Dotcom-Monitor предоставляет ресурсы для дополнительных кодов ошибок Объяснил. Узнайте больше о конкретных описаниях кода ошибок здесь, на нашей Вики.