Описание полей:
- Тег invnn:
- Описание: номер объявления или другого объекта в локальной базе программы.
- Возможные значения: любые.
- Параметры: нет.
- Обязательное наличие: нет.
- Тег item_id:
- Описание: номер объявления или другого объекта к которому относится это сообщение. Если тег item_id отсутствует, это означает что сообщение относится ко всему процессу получающему ответ.
- Возможные значения: числовой(id) или буквенно-числовой(hash) номер объявления.
- Параметры: нет.
- Обязательное наличие: да (для добавления).
- Тег result:
- Описание: результат операции или действия. Возможные значения:
- ERROR – ошибка;
- SUCCESS – удачное завершение операции.
- Параметры: нет.
- Обязательное наличие: да.
- Описание: результат операции или действия. Возможные значения:
- Тег code:
- Описание: предназначен для использования в качестве отладочной информации для определения места генерации сообщения в скрипте. Коды ошибок уникальны и позволяют быстро и безошибочно определить место возникновения ошибки. Коды успешных операций могут совпадать для одинаковых групп действий (работа с объявлениями: добавление/редактирование/удаление; работа с биллингом: запрос счета/количества добавленных объявлений и т.д.).
- Возможные значения: код из таблицы кодов.
- Параметры: нет.
- Обязательное наличие: да.
- Тег action:
- Описание: предназначен для описания действия на которое было сгенерированно сообщение.
- Возможные значения: любые.
- Параметры: нет.
- Обязательное наличие: нет.
- Тег group:
- Описание: источник сообщения.
- Возможные значения: любые.
- Параметры:
- id - идентификатор группы.
- area – раздел для объявлений или другого объекта.
- Обязательное наличие: да.
- Тег datetime:
- Описание: Дата и время генерации сообщения.
- Возможные значения: дата и время в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.
- Параметры: нет.
- Обязательное наличие: да.
- Тег text:
- Описание: Текст сообщения. Здесь могут передаваться как сообщение об ошибке так и об успешном выполнении операции и другая информация в текстовом виде.
- Возможные значения: любые.
- Параметры: нет.
- Обязательное наличие: да.
- Тег warning:
- Описание: В процессе выполнения какой-либо операции могут появиться не критичные ошибки, не влияющие на успешное выполнение операции. Данный тег предназначен для передачи предупреждений о таких ошибках. Все warning-и имеют уникальные коды ошибок.
- Возможные значения: любые.
- Параметры: id – унифицированный код сообщения.
- Обязательное наличие: нет.
- Может быть несколько тегов такого типа в одном message.
- Тег notice:
- Описание: Предназначен для передачи сопутствующей информации о совершаемой операции. Все notice-ы имеют уникальные коды.
- Возможные значения: любые.
- Параметры: id – унифицированный код сообщения.
- Обязательное наличие: нет.
- Может быть несколько тегов такого типа в одном message.
- Тег link:
- Описание: полезные ссылки соответствующие ответу. Например адреса объявлений на дружественных ресурсах, информационные ссылки о счете или регистрации программы и т.д. Перечисление ссылок идет в каждом отдельном теге link.
- Возможные значения: любые.
- Параметры: site – сайт к которому относится ссылка.
- Обязательное наличие: нет.
- Может быть несколько тегов такого типа в одном message.
Тег techinfo:
- Описание: Техническая информация. Тег предназначен для передачи информации технического характера. Данные передаются в формате json.
Возможные значения: любые.
Параметры: нет.
Обязательное наличие: нет.
Тег debuginfo:
- Техническая информация. Всевозможные неструктурированные данные предназначенные для отладки операций и возникающих ошибок.
- Возможные значения: любые.
- Параметры: нет.
- Обязательное наличие: нет.