# Изменение параметров, добавление/удаление баз

Спецификация для изменения параметров, добавления/удаления баз: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

Кодировка XML-документов: **`UTF-8`**

Обязательный заголовок: **`Content-type: text/xml; charset=utf-8;`**

Адрес для запроса: **`https://my3.webcom.mobi/xml/bases.php`**

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="210">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark>*</p></td><td>String</td><td>Текст поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[id_base]</mark></p></td><td>Int</td><td><p>Уникальный номер базы в системе. </p><p><mark style="color:orange;">Если не указан произойдет добавление базы. При этом нужно указать параметр <strong>number_base</strong></mark></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[number_base]</mark></p></td><td>Int</td><td>Номер базы в XMLзапросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было несколько в запросе)</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[name_base]</mark></p></td><td>Int</td><td>Название базы</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[time_birth]</mark></p></td><td>Time</td><td>Время поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[local_time_birth]</mark></p></td><td>String</td><td>Считать время поздравления относительно местного времени абонента (<strong><code>yes</code></strong>) или относительно времени системы (<strong><code>no</code></strong>)</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[originator_birth]</mark></p></td><td>String</td><td>Отправитель поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[on_birth]</mark></p></td><td>Int</td><td><p>Включены ли поздравления:</p><ul><li>yes – включены </li><li>no - выключены</li></ul></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.delete_bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[id_base]</mark></p></td><td>Int</td><td>Уникальный номер базы в системе, который необходимо удалить</td></tr></tbody></table>

\*- обязательный параметр

### В случае получения правильного XML-документа

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base=”1234”>edit</base>
     <base number_base=”1” id_base=”1235”>insert</base>
     <base number_base=”2” id_base=”1236”>edit</base>
     <base id_base=”1235”>delete</base>
     <base id_base=”1235”>not_found</base>
…
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p></td><td>Sting</td><td>Действие</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark></p></td><td>Int</td><td>Уникальный номер базы в системе. </td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[number_base]</mark></p></td><td>Int</td><td>Номер базы в XML запросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе)</td></tr></tbody></table>

### &#x20;В случае возникновения ошибки в отправленном XML-документе

```xml
<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
```

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### &#x20;Пример XML запроса

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <bases>
          <base id_base="1234" name_base="База главного офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
          <base number_base="1" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     </bases>
     <delete_bases>
          <base id_base="1235" />
          <base id_base="1236" />
          …
     </delete_bases>
</request>
```

{% endtab %}
{% endtabs %}