API Справочники

Работа со справочниками.

Перечень ошибок

Метод «getMessageCodeText», работает в модели «CommonGeneral», этот метод необходим для скачивания справочника с описанием перечня ошибок.
Метод постоянно пополняется новым описанием на трех языках.
Для обновления данных, справочник необходимо загружать один раз в месяц.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

(дополнительный)
string

Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties* string Свойства метода
* Обозначение обязательного параметра

{
    "apiKey": "[ВАШ КЛЮЧ]",
    "modelName": "CommonGeneral",
    "calledMethod": "getMessageCodeText",
    "methodProperties": {}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <calledMethod>getMessageCodeText</calledMethod>
   <methodProperties />
   <modelName>CommonGeneral</modelName>
</root>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.

Параметр Тип данных Описание
MessageCode string[36] Код ошибки
MessageText string[100] Описание на Английском языке
MessageDescriptionRU string[100] Описание на русском языке
MessageDescriptionUA string[100] Описание на Украинском языке

{
  "success": true,
  "data": [
    {
      "result": [
        {
          "MessageCode": "20000100004",
          "MessageText": "User with email exists",
          "MessageDescriptionRU": "Отсутствует пользователь с таким Email",
          "MessageDescriptionUA": "Відсутній користувач з таким Email"
        },
        {
          "MessageCode": "20000100002",
          "MessageText": "General error",
          "MessageDescriptionRU": "Область получателя не выбрана",
          "MessageDescriptionUA": "Область одержувача не вибрана"
        },
        {
          "MessageCode": "20000400455",
          "MessageText": "DateTime cannot be less then now",
          "MessageDescriptionRU": "Дата не может быть меньше, чем сегодня",
          "MessageDescriptionUA": "Дата не може бути менше, ніж сьогодні"
        },
        {
          "MessageCode": "20000100005",
          "MessageText": "Необходимо отметить только один документ",
          "MessageDescriptionRU": "Необходимо отметить только один документ",
          "MessageDescriptionUA": "Необхідно відзначити тільки один документ"
        },
        {
          "MessageCode": "20000100006",
          "MessageText": "Exceeded the limit of sent SMS",
          "MessageDescriptionRU": "Превышен лимит отправленных SMS",
          "MessageDescriptionUA": "Перевищено ліміт відправлених SMS"
        },
        {
          "MessageCode": "20001001394",
          "MessageText": "Specify SettlementRef or WarehouseRef for this topics",
          "MessageDescriptionRU": null,
          "MessageDescriptionUA": null
        }
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <result>
                <item>
                    <MessageCode>20000100004</MessageCode>
                    <MessageText>User with email exists</MessageText>
                    <MessageDescriptionRU>Отсутствует пользователь с таким Email</MessageDescriptionRU>
                    <MessageDescriptionUA>Відсутній користувач з таким Email</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000100002</MessageCode>
                    <MessageText>General error</MessageText>
                    <MessageDescriptionRU>Область получателя не выбрана</MessageDescriptionRU>
                    <MessageDescriptionUA>Область одержувача не вибрана</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000400455</MessageCode>
                    <MessageText>DateTime cannot be less then now</MessageText>
                    <MessageDescriptionRU>Дата не может быть меньше, чем сегодня</MessageDescriptionRU>
                    <MessageDescriptionUA>Дата не може бути менше, ніж сьогодні</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000100005</MessageCode>
                    <MessageText>Необходимо отметить только один документ</MessageText>
                    <MessageDescriptionRU>Необходимо отметить только один документ</MessageDescriptionRU>
                    <MessageDescriptionUA>Необхідно відзначити тільки один документ</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000100006</MessageCode>
                    <MessageText>Exceeded the limit of sent SMS</MessageText>
                    <MessageDescriptionRU>Превышен лимит отправленных SMS</MessageDescriptionRU>
                    <MessageDescriptionUA>Перевищено ліміт відправлених SMS</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000100007</MessageCode>
                    <MessageText>Activation error</MessageText>
                    <MessageDescriptionRU>Ошибка активации</MessageDescriptionRU>
                    <MessageDescriptionUA>Помилка активації</MessageDescriptionUA>
                </item>
                <item>
                    <MessageCode>20000100008</MessageCode>
                    <MessageText>An unknown error occurred. Try again later.</MessageText>
                    <MessageDescriptionRU>Произошла неизвестная ошибка. Попробуйте позже</MessageDescriptionRU>
                    <MessageDescriptionUA>Виникла невідома помилка. Спробуйте пізніше</MessageDescriptionUA>
                </item>
   <item>
                    <MessageCode>20001001394</MessageCode>
                    <MessageText>Specify SettlementRef or WarehouseRef for this topics</MessageText>
                    <MessageDescriptionRU/>
                    <MessageDescriptionUA/>
                </item>
            </result>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>